GraphDefinition - FHIR Resource (r4)
This GraphDefinition Resource uses the FHIR API standard for access and structure.
Validate an GraphDefinition FHIR Resource (r4)
GraphDefinition Attributes
AttributeField is listTypeDescription
Description: Canonical identifier for this graph definition, represented as a URI (globally unique)
FHIR Version: r4
Attribute Type : uri
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"url": "http://h7.org/fhir/GraphDefinition/example"Learn more about the (GraphDefinition) url FHIR attribute
Description: Business version of the graph definition
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"version": Learn more about the (GraphDefinition) version FHIR attribute
Description: C? Name for this graph definition (computer friendly)
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"name": "Document Generation Template"Learn more about the (GraphDefinition) name FHIR attribute
Description: draft | active | retired | unknown
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "draft"Learn more about the (GraphDefinition) status FHIR attribute
Description: For testing purposes, not real usage
FHIR Version: r4
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"experimental": Learn more about the (GraphDefinition) experimental FHIR attribute
Description: Date last changed
FHIR Version: r4
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"date": "2015-08-04"Learn more about the (GraphDefinition) date FHIR attribute
Description: Name of the publisher (organization or individual)
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"publisher": "FHIR Project"Learn more about the (GraphDefinition) publisher FHIR attribute
Description: Contact details for the publisher
FHIR Version: r4
Attribute Type : ContactDetail
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
}
]Learn more about the (GraphDefinition) contact FHIR attribute
Description: Natural language description of the graph definition
FHIR Version: r4
Attribute Type : markdown
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"description": "Specify to include list references when generating a document using the $document operation"Learn more about the (GraphDefinition) description FHIR attribute
Description: The context that the content is intended to support
FHIR Version: r4
Attribute Type : UsageContext
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"useContext": Learn more about the (GraphDefinition) useContext FHIR attribute
Description: Intended jurisdiction for graph definition (if applicable)
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"jurisdiction": Learn more about the (GraphDefinition) jurisdiction FHIR attribute
Description: Why this graph definition is defined
FHIR Version: r4
Attribute Type : markdown
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"purpose": Learn more about the (GraphDefinition) purpose FHIR attribute
Description: Type of resource at which the graph starts
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"start": "Composition"Learn more about the (GraphDefinition) start FHIR attribute
Description: Profile on base resource
FHIR Version: r4
Attribute Type : canonical(StructureDefinition)
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"profile": Learn more about the (GraphDefinition) profile FHIR attribute
Description: Links this graph makes rules about
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"link": [
{
"path": "Composition.section.entry",
"description": "Link to List",
"target": [
{
"type": "List",
"compartment": [
{
"use": "requirement",
"code": "Patient",
"rule": "identical"
}
],
"link": [
{
"path": "List.entry.item",
"description": "Include any list entries",
"target": [
{
"type": "Resource",
"compartment": [
{
"use": "requirement",
"code": "Patient",
"rule": "identical"
}
]
}
]
}
]
}
]
}
]Learn more about the (GraphDefinition) link FHIR attribute
GraphDefinition Example
{
"resourceType": "GraphDefinition",
"id": "example",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p><p><b>url</b>: <b>http://h7.org/fhir/GraphDefinition/example</b></p><p><b>name</b>: Document Generation Template</p><p><b>status</b>: draft</p><p><b>date</b>: 04/08/2015</p><p><b>publisher</b>: FHIR Project</p><p><b>contact</b>: </p><p><b>description</b>: Specify to include list references when generating a document using the $document operation</p><p><b>start</b>: Composition</p><blockquote><p><b>link</b></p><p><b>path</b>: Composition.section.entry</p><p><b>description</b>: Link to List</p><blockquote><p><b>target</b></p><p><b>type</b>: List</p><h3>Compartments</h3><table><tr><td>-</td><td><b>Use</b></td><td><b>Code</b></td><td><b>Rule</b></td></tr><tr><td>*</td><td>requirement</td><td>Patient</td><td>identical</td></tr></table><h3>Links</h3><table><tr><td>-</td></tr><tr><td>*</td></tr></table></blockquote></blockquote></div>"
},
"url": "http://h7.org/fhir/GraphDefinition/example",
"name": "Document Generation Template",
"status": "draft",
"date": "2015-08-04",
"publisher": "FHIR Project",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
}
],
"description": "Specify to include list references when generating a document using the $document operation",
"start": "Composition",
"link": [
{
"path": "Composition.section.entry",
"description": "Link to List",
"target": [
{
"type": "List",
"compartment": [
{
"use": "requirement",
"code": "Patient",
"rule": "identical"
}
],
"link": [
{
"path": "List.entry.item",
"description": "Include any list entries",
"target": [
{
"type": "Resource",
"compartment": [
{
"use": "requirement",
"code": "Patient",
"rule": "identical"
}
]
}
]
}
]
}
]
}
]
}GraphDefinition Structure
{
"resourceType" : "GraphDefinition",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"url" : "<uri>", // Canonical identifier for this graph definition, represented as a URI (globally unique)
"version" : "<string>", // Business version of the graph definition
"name" : "<string>", // C? R! Name for this graph definition (computer friendly)
"status" : "<code>", // R! draft | active | retired | unknown
"experimental" : <boolean>, // For testing purposes, not real usage
"date" : "<dateTime>", // Date last changed
"publisher" : "<string>", // Name of the publisher (organization or individual)
"contact" : [{ ContactDetail }], // Contact details for the publisher
"description" : "<markdown>", // Natural language description of the graph definition
"useContext" : [{ UsageContext }], // The context that the content is intended to support
"jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for graph definition (if applicable)
"purpose" : "<markdown>", // Why this graph definition is defined
"start" : "<code>", // R! Type of resource at which the graph starts
"profile" : { canonical(StructureDefinition) }, // Profile on base resource
"link" : [{ // Links this graph makes rules about
"path" : "<string>", // Path in the resource that contains the link
"sliceName" : "<string>", // Which slice (if profiled)
"min" : <integer>, // Minimum occurrences for this link
"max" : "<string>", // Maximum occurrences for this link
"description" : "<string>", // Why this link is specified
"target" : [{ // Potential target for the link
"type" : "<code>", // R! Type of resource this link refers to
"params" : "<string>", // Criteria for reverse lookup
"profile" : { canonical(StructureDefinition) }, // Profile for the target resource
"compartment" : [{ // Compartment Consistency Rules
"use" : "<code>", // R! condition | requirement
"code" : "<code>", // R! Patient | Encounter | RelatedPerson | Practitioner | Device
"rule" : "<code>", // R! identical | matching | different | custom
"expression" : "<string>", // Custom rule, as a FHIRPath expression
"description" : "<string>" // Documentation for FHIRPath expression
}],
"link" : [{ Content as for GraphDefinition.link }] // Additional links from target resource
}]
}]
}
GraphDefinition Search Parameters
The following search parameters can be used to query GraphDefinition resources. Just submit them like so:
https://api.1up.health/fhir/r4/GraphDefinition?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
context | text | useContext.value |
context-quantity | quantity | useContext.value |
context-type | text | useContext.code |
context-type-quantity | composite | useContext |
context-type-value | composite | useContext |
date | date | date |
description | text | description |
jurisdiction | text | jurisdiction |
name | text | name |
publisher | text | publisher |
start | text | start |
status | text | status |
url | uri | url |
version | text | version |
