SMART Base, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-base/ and changes regularly. See the Directory of published versions
Resource Profile: SMART Guidelines Transaction
| Official URL: http://smart.who.int/base/StructureDefinition/SGTransaction | Version: 0.3.0 | |||
| Draft as of 2026-10-20 | Computable Name: SGTransaction | |||
SMART Guidelines Transaction Definition
Usages:
- This Profile is not used by any profiles in this Specification
You can also check for usages in the FHIR IG Statistics
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  GraphDefinition |
C | 0..* | SGGraphDefinition | Definition of a graph of resources Constraints: gdf-0 |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
  Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
   extension:node |
2..2 | (Complex) | R5: Potential target for the link (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-GraphDefinition.node Constraints: ext-1 | |
 extension:node/source |
1..1 | (Complex) | R5: Potential target for the link (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-GraphDefinition.node Constraints: ext-1 | |
  Slices for extension |
3..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
  Slices for extension |
Content/Rules for all slices | |||
 extension:nodeId |
1..1 | Extension | R5: Internal ID - target for link references (new) Constraints: ext-1 | |
| url |
1..1 | uri | "nodeId" | |
 value[x] |
1..1 | id | Internal ID - target for link references Required Pattern: source (extensions allowed) | |
| extension:description |
0..1 | Extension | R5: Why this node is specified (new) Constraints: ext-1 | |
| url |
1..1 | uri | "description" | |
| extension:type |
1..1 | Extension | R5: Type of resource this link refers to (new) Constraints: ext-1 | |
| url |
1..1 | uri | "type" | |
| value[x] |
1..1 | code | Type of resource this link refers to Binding: R5VersionIndependentAllResourceTypesForR4 (0.1.0) (required): A type of resource, or a Reference (from all versions) Required Pattern: ActorDefinition (extensions allowed) | |
| extension:profile |
0..1 | Extension | R5: Profile for the target resource (new) Constraints: ext-1 | |
| url |
1..1 | uri | "profile" | |
 extension:actor |
1..* | Reference(SGActor) | Extension URL: http://smart.who.int/base/StructureDefinition/SGActorExt | |
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-GraphDefinition.node" | |
 extension:node/target |
1..1 | (Complex) | R5: Potential target for the link (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-GraphDefinition.node Constraints: ext-1 | |
 Slices for extension |
3..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:nodeId |
1..1 | Extension | R5: Internal ID - target for link references (new) Constraints: ext-1 | |
| url |
1..1 | uri | "nodeId" | |
| value[x] |
1..1 | id | Internal ID - target for link references Required Pattern: target (extensions allowed) | |
| extension:description |
0..1 | Extension | R5: Why this node is specified (new) Constraints: ext-1 | |
| url |
1..1 | uri | "description" | |
| extension:type |
1..1 | Extension | R5: Type of resource this link refers to (new) Constraints: ext-1 | |
| url |
1..1 | uri | "type" | |
| value[x] |
1..1 | code | Type of resource this link refers to Binding: R5VersionIndependentAllResourceTypesForR4 (0.1.0) (required): A type of resource, or a Reference (from all versions) Required Pattern: ActorDefinition (extensions allowed) | |
| extension:profile |
0..1 | Extension | R5: Profile for the target resource (new) Constraints: ext-1 | |
| url |
1..1 | uri | "profile" | |
| extension:actor |
1..* | Reference(SGActor) | Extension URL: http://smart.who.int/base/StructureDefinition/SGActorExt | |
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-GraphDefinition.node" | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| name |
C | 1..1 | string | Name for this graph definition (computer friendly) |
| status |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | |
| experimental |
1..1 | boolean | For testing purposes, not real usage | |
| description |
1..1 | markdown | Natural language description of the graph definition | |
| start |
1..1 | code | Type of resource at which the graph starts Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | |
  link |
1..1 | BackboneElement | Links this graph makes rules about | |
| Slices for extension |
7..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:sourceId |
0..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/LinkIdExt | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/LinkIdExt" | |
| value[x] |
0..1 | id | Value of extension Required Pattern: source (extensions allowed) | |
| extension:targetId |
0..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/LinkIdExt | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/LinkIdExt" | |
| value[x] |
0..1 | id | Value of extension Required Pattern: target (extensions allowed) | |
| extension:requestTrigger |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:code |
1..1 | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGcode | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGcode" | |
 value[x] |
1..1 | Coding | Value of extension Required Pattern: | |
| system |
1..1 | uri | Identity of the terminology system | |
 code |
1..1 | code | Symbol in syntax defined by the system | |
| extension:doc |
1..1 | markdown | Extension URL: http://smart.who.int/base/StructureDefinition/SGMarkdown | |
| extension:requirements |
0..* | Reference(SMART Guidelines Requirements) | Extension URL: http://smart.who.int/base/StructureDefinition/SGRequirementExt | |
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGDocumentation" | |
| extension:requestSemantics |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:code |
1..1 | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGcode | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGcode" | |
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| extension:doc |
1..1 | markdown | Extension URL: http://smart.who.int/base/StructureDefinition/SGMarkdown | |
| extension:requirements |
0..* | Reference(SMART Guidelines Requirements) | Extension URL: http://smart.who.int/base/StructureDefinition/SGRequirementExt | |
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGDocumentation" | |
| extension:requestActions |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:code |
1..1 | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGcode | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGcode" | |
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| extension:doc |
1..1 | markdown | Extension URL: http://smart.who.int/base/StructureDefinition/SGMarkdown | |
| extension:requirements |
0..* | Reference(SMART Guidelines Requirements) | Extension URL: http://smart.who.int/base/StructureDefinition/SGRequirementExt | |
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGDocumentation" | |
| extension:responseTrigger |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:code |
1..1 | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGcode | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGcode" | |
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| extension:doc |
1..1 | markdown | Extension URL: http://smart.who.int/base/StructureDefinition/SGMarkdown | |
| extension:requirements |
0..* | Reference(SMART Guidelines Requirements) | Extension URL: http://smart.who.int/base/StructureDefinition/SGRequirementExt | |
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGDocumentation" | |
| extension:responseSemantics |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:code |
1..1 | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGcode | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGcode" | |
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| extension:doc |
1..1 | markdown | Extension URL: http://smart.who.int/base/StructureDefinition/SGMarkdown | |
| extension:requirements |
0..* | Reference(SMART Guidelines Requirements) | Extension URL: http://smart.who.int/base/StructureDefinition/SGRequirementExt | |
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGDocumentation" | |
| extension:responseActions |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:code |
1..1 | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGcode | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGcode" | |
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| extension:doc |
1..1 | markdown | Extension URL: http://smart.who.int/base/StructureDefinition/SGMarkdown | |
| extension:requirements |
0..* | Reference(SMART Guidelines Requirements) | Extension URL: http://smart.who.int/base/StructureDefinition/SGRequirementExt | |
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGDocumentation" | |
| extension:securityConsiderations |
1..1 | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:code |
1..1 | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGcode | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGcode" | |
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| extension:doc |
1..1 | markdown | Extension URL: http://smart.who.int/base/StructureDefinition/SGMarkdown | |
| extension:requirements |
0..* | Reference(SMART Guidelines Requirements) | Extension URL: http://smart.who.int/base/StructureDefinition/SGRequirementExt | |
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGDocumentation" | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| GraphDefinition.extension:node/source.extension:type.value[x] | Base | required | Cross-version ValueSet R5.VersionIndependentResourceTypesAll for use in FHIR R4 | 📍0.1.0 | Extensions for Using Data Elements from FHIR R5 in FHIR R4 v0.1 |
| GraphDefinition.extension:node/target.extension:type.value[x] | Base | required | Cross-version ValueSet R5.VersionIndependentResourceTypesAll for use in FHIR R4 | 📍0.1.0 | Extensions for Using Data Elements from FHIR R5 in FHIR R4 v0.1 |
| GraphDefinition.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| GraphDefinition.start | Base | required | ResourceType | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | GraphDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | GraphDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | GraphDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | GraphDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | GraphDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| gdf-0 | warning | GraphDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
This structure is derived from SGGraphDefinition
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| GraphDefinition |
0..* | SGGraphDefinition | Definition of a graph of resources | |
| extension |
2..* | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| Slices for extension:node |
2..2 | R5 GraphDefinition.node | R5: Potential target for the link (new) Slice: Unordered, Closed by value:nodeId Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:node/source |
1..1 | R5 GraphDefinition.node | R5: Potential target for the link (new) | |
| extension |
3..* | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:nodeId |
1..1 | Extension | R5: Internal ID - target for link references (new) | |
 value[x] |
1..1 | id | Internal ID - target for link references Required Pattern: source (extensions allowed) | |
| extension:type |
1..1 | Extension | R5: Type of resource this link refers to (new) | |
| value[x] |
1..1 | code | Type of resource this link refers to Required Pattern: ActorDefinition (extensions allowed) | |
| extension:actor |
1..* | Reference(SGActor) | Extension URL: http://smart.who.int/base/StructureDefinition/SGActorExt | |
| extension:node/target |
1..1 | R5 GraphDefinition.node | R5: Potential target for the link (new) | |
| extension |
3..* | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:nodeId |
1..1 | Extension | R5: Internal ID - target for link references (new) | |
| value[x] |
1..1 | id | Internal ID - target for link references Required Pattern: target (extensions allowed) | |
| extension:type |
1..1 | Extension | R5: Type of resource this link refers to (new) | |
| value[x] |
1..1 | code | Type of resource this link refers to Required Pattern: ActorDefinition (extensions allowed) | |
| extension:actor |
1..* | Reference(SGActor) | Extension URL: http://smart.who.int/base/StructureDefinition/SGActorExt | |
| link |
1..1 | BackboneElement | Links this graph makes rules about | |
| extension |
7..* | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:sourceId |
0..* | LinkIdExt | Extension | |
| value[x] |
0..1 | id | Value of extension Required Pattern: source (extensions allowed) | |
| extension:targetId |
0..* | LinkIdExt | Extension | |
| value[x] |
0..1 | id | Value of extension Required Pattern: target (extensions allowed) | |
| extension:requestTrigger |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:code |
1..1 | SGcode | Extension | |
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |
| extension:requestSemantics |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:code |
1..1 | SGcode | Extension | |
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |
| extension:requestActions |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:code |
1..1 | SGcode | Extension | |
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |
| extension:responseTrigger |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:code |
1..1 | SGcode | Extension | |
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |
| extension:responseSemantics |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:code |
1..1 | SGcode | Extension | |
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |
| extension:responseActions |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:code |
1..1 | SGcode | Extension | |
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |
| extension:securityConsiderations |
1..1 | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:code |
1..1 | SGcode | Extension | |
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| GraphDefinition |
C | 0..* | SGGraphDefinition | Definition of a graph of resources Constraints: gdf-0 | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:node |
2..2 | (Complex) | R5: Potential target for the link (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-GraphDefinition.node Constraints: ext-1 | |||||
| extension:node/source |
1..1 | (Complex) | R5: Potential target for the link (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-GraphDefinition.node Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
3..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:nodeId |
1..1 | Extension | R5: Internal ID - target for link references (new) Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| url |
1..1 | uri | "nodeId" | |||||
| value[x] |
1..1 | id | Internal ID - target for link references Required Pattern: source (extensions allowed) | |||||
| extension:description |
0..1 | Extension | R5: Why this node is specified (new) Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| url |
1..1 | uri | "description" | |||||
| value[x] |
0..1 | string | Why this node is specified | |||||
| extension:type |
1..1 | Extension | R5: Type of resource this link refers to (new) Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| url |
1..1 | uri | "type" | |||||
| value[x] |
1..1 | code | Type of resource this link refers to Binding: R5VersionIndependentAllResourceTypesForR4 (0.1.0) (required): A type of resource, or a Reference (from all versions) Required Pattern: ActorDefinition (extensions allowed) | |||||
| extension:profile |
0..1 | Extension | R5: Profile for the target resource (new) Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| url |
1..1 | uri | "profile" | |||||
| value[x] |
0..1 | canonical(Cross-version Profile for R5.StructureDefinition for use in FHIR R4(0.1.0) | StructureDefinition) | Profile for the target resource | |||||
| extension:actor |
1..* | Reference(SGActor) | Extension URL: http://smart.who.int/base/StructureDefinition/SGActorExt | |||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-GraphDefinition.node" | |||||
| extension:node/target |
1..1 | (Complex) | R5: Potential target for the link (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-GraphDefinition.node Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
3..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:nodeId |
1..1 | Extension | R5: Internal ID - target for link references (new) Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| url |
1..1 | uri | "nodeId" | |||||
| value[x] |
1..1 | id | Internal ID - target for link references Required Pattern: target (extensions allowed) | |||||
| extension:description |
0..1 | Extension | R5: Why this node is specified (new) Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| url |
1..1 | uri | "description" | |||||
| value[x] |
0..1 | string | Why this node is specified | |||||
| extension:type |
1..1 | Extension | R5: Type of resource this link refers to (new) Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| url |
1..1 | uri | "type" | |||||
| value[x] |
1..1 | code | Type of resource this link refers to Binding: R5VersionIndependentAllResourceTypesForR4 (0.1.0) (required): A type of resource, or a Reference (from all versions) Required Pattern: ActorDefinition (extensions allowed) | |||||
| extension:profile |
0..1 | Extension | R5: Profile for the target resource (new) Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| url |
1..1 | uri | "profile" | |||||
| value[x] |
0..1 | canonical(Cross-version Profile for R5.StructureDefinition for use in FHIR R4(0.1.0) | StructureDefinition) | Profile for the target resource | |||||
| extension:actor |
1..* | Reference(SGActor) | Extension URL: http://smart.who.int/base/StructureDefinition/SGActorExt | |||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-GraphDefinition.node" | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| url |
0..1 | uri | Canonical identifier for this graph definition, represented as a URI (globally unique) | |||||
| version |
0..1 | string | Business version of the graph definition | |||||
| name |
C | 1..1 | string | Name for this graph definition (computer friendly) | ||||
| status |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | |||||
| experimental |
1..1 | boolean | For testing purposes, not real usage | |||||
| date |
0..1 | dateTime | Date last changed | |||||
| publisher |
0..1 | string | Name of the publisher (organization or individual) | |||||
| contact |
0..* | ContactDetail | Contact details for the publisher | |||||
| description |
1..1 | markdown | Natural language description of the graph definition | |||||
| useContext |
0..* | UsageContext | The context that the content is intended to support | |||||
| jurisdiction |
0..* | CodeableConcept | Intended jurisdiction for graph definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | |||||
| purpose |
0..1 | markdown | Why this graph definition is defined | |||||
| start |
1..1 | code | Type of resource at which the graph starts Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | |||||
| profile |
0..1 | canonical(StructureDefinition) | Profile on base resource | |||||
| link |
1..1 | BackboneElement | Links this graph makes rules about | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
7..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:sourceId |
0..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/LinkIdExt | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/LinkIdExt" | |||||
| value[x] |
0..1 | id | Value of extension Required Pattern: source (extensions allowed) | |||||
| extension:targetId |
0..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/LinkIdExt | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/LinkIdExt" | |||||
| value[x] |
0..1 | id | Value of extension Required Pattern: target (extensions allowed) | |||||
| extension:requestTrigger |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:code |
1..1 | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGcode | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGcode" | |||||
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| extension:doc |
1..1 | markdown | Extension URL: http://smart.who.int/base/StructureDefinition/SGMarkdown | |||||
| extension:requirements |
0..* | Reference(SMART Guidelines Requirements) | Extension URL: http://smart.who.int/base/StructureDefinition/SGRequirementExt | |||||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGDocumentation" | |||||
| extension:requestSemantics |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:code |
1..1 | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGcode | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGcode" | |||||
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| extension:doc |
1..1 | markdown | Extension URL: http://smart.who.int/base/StructureDefinition/SGMarkdown | |||||
| extension:requirements |
0..* | Reference(SMART Guidelines Requirements) | Extension URL: http://smart.who.int/base/StructureDefinition/SGRequirementExt | |||||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGDocumentation" | |||||
| extension:requestActions |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:code |
1..1 | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGcode | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGcode" | |||||
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| extension:doc |
1..1 | markdown | Extension URL: http://smart.who.int/base/StructureDefinition/SGMarkdown | |||||
| extension:requirements |
0..* | Reference(SMART Guidelines Requirements) | Extension URL: http://smart.who.int/base/StructureDefinition/SGRequirementExt | |||||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGDocumentation" | |||||
| extension:responseTrigger |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:code |
1..1 | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGcode | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGcode" | |||||
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| extension:doc |
1..1 | markdown | Extension URL: http://smart.who.int/base/StructureDefinition/SGMarkdown | |||||
| extension:requirements |
0..* | Reference(SMART Guidelines Requirements) | Extension URL: http://smart.who.int/base/StructureDefinition/SGRequirementExt | |||||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGDocumentation" | |||||
| extension:responseSemantics |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:code |
1..1 | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGcode | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGcode" | |||||
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| extension:doc |
1..1 | markdown | Extension URL: http://smart.who.int/base/StructureDefinition/SGMarkdown | |||||
| extension:requirements |
0..* | Reference(SMART Guidelines Requirements) | Extension URL: http://smart.who.int/base/StructureDefinition/SGRequirementExt | |||||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGDocumentation" | |||||
| extension:responseActions |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:code |
1..1 | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGcode | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGcode" | |||||
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| extension:doc |
1..1 | markdown | Extension URL: http://smart.who.int/base/StructureDefinition/SGMarkdown | |||||
| extension:requirements |
0..* | Reference(SMART Guidelines Requirements) | Extension URL: http://smart.who.int/base/StructureDefinition/SGRequirementExt | |||||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGDocumentation" | |||||
| extension:securityConsiderations |
1..1 | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:code |
1..1 | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGcode | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGcode" | |||||
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| extension:doc |
1..1 | markdown | Extension URL: http://smart.who.int/base/StructureDefinition/SGMarkdown | |||||
| extension:requirements |
0..* | Reference(SMART Guidelines Requirements) | Extension URL: http://smart.who.int/base/StructureDefinition/SGRequirementExt | |||||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGDocumentation" | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| path |
0..1 | string | Path in the resource that contains the link | |||||
| sliceName |
0..1 | string | Which slice (if profiled) | |||||
| min |
0..1 | integer | Minimum occurrences for this link | |||||
| max |
0..1 | string | Maximum occurrences for this link | |||||
| description |
0..1 | string | Why this link is specified | |||||
| target |
0..* | BackboneElement | Potential target for the link | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| type |
1..1 | code | Type of resource this link refers to Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | |||||
| params |
0..1 | string | Criteria for reverse lookup | |||||
| profile |
0..1 | canonical(StructureDefinition) | Profile for the target resource | |||||
| compartment |
0..* | BackboneElement | Compartment Consistency Rules | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| use |
1..1 | code | condition | requirement Binding: GraphCompartmentUse (required): Defines how a compartment rule is used. | |||||
| code |
1..1 | code | Patient | Encounter | RelatedPerson | Practitioner | Device Binding: CompartmentType (required): Identifies a compartment. | |||||
| rule |
1..1 | code | identical | matching | different | custom Binding: GraphCompartmentRule (required): How a compartment must be linked. | |||||
| expression |
0..1 | string | Custom rule, as a FHIRPath expression | |||||
| description |
0..1 | string | Documentation for FHIRPath expression | |||||
| link |
0..* | See link (GraphDefinition) | Additional links from target resource | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| GraphDefinition.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| GraphDefinition.extension:node/source.extension:type.value[x] | Base | required | Cross-version ValueSet R5.VersionIndependentResourceTypesAll for use in FHIR R4 | 📍0.1.0 | Extensions for Using Data Elements from FHIR R5 in FHIR R4 v0.1 |
| GraphDefinition.extension:node/target.extension:type.value[x] | Base | required | Cross-version ValueSet R5.VersionIndependentResourceTypesAll for use in FHIR R4 | 📍0.1.0 | Extensions for Using Data Elements from FHIR R5 in FHIR R4 v0.1 |
| GraphDefinition.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| GraphDefinition.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std. |
| GraphDefinition.start | Base | required | ResourceType | 📍4.0.1 | FHIR Std. |
| GraphDefinition.link.target.type | Base | required | ResourceType | 📍4.0.1 | FHIR Std. |
| GraphDefinition.link.target.compartment.use | Base | required | GraphCompartmentUse | 📍4.0.1 | FHIR Std. |
| GraphDefinition.link.target.compartment.code | Base | required | CompartmentType | 📍4.0.1 | FHIR Std. |
| GraphDefinition.link.target.compartment.rule | Base | required | GraphCompartmentRule | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | GraphDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | GraphDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | GraphDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | GraphDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | GraphDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| gdf-0 | warning | GraphDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
This structure is derived from SGGraphDefinition
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| GraphDefinition |
C | 0..* | SGGraphDefinition | Definition of a graph of resources Constraints: gdf-0 |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:node |
2..2 | (Complex) | R5: Potential target for the link (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-GraphDefinition.node Constraints: ext-1 | |
| extension:node/source |
1..1 | (Complex) | R5: Potential target for the link (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-GraphDefinition.node Constraints: ext-1 | |
| Slices for extension |
3..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:nodeId |
1..1 | Extension | R5: Internal ID - target for link references (new) Constraints: ext-1 | |
| url |
1..1 | uri | "nodeId" | |
| value[x] |
1..1 | id | Internal ID - target for link references Required Pattern: source (extensions allowed) | |
| extension:description |
0..1 | Extension | R5: Why this node is specified (new) Constraints: ext-1 | |
| url |
1..1 | uri | "description" | |
| extension:type |
1..1 | Extension | R5: Type of resource this link refers to (new) Constraints: ext-1 | |
| url |
1..1 | uri | "type" | |
| value[x] |
1..1 | code | Type of resource this link refers to Binding: R5VersionIndependentAllResourceTypesForR4 (0.1.0) (required): A type of resource, or a Reference (from all versions) Required Pattern: ActorDefinition (extensions allowed) | |
| extension:profile |
0..1 | Extension | R5: Profile for the target resource (new) Constraints: ext-1 | |
| url |
1..1 | uri | "profile" | |
| extension:actor |
1..* | Reference(SGActor) | Extension URL: http://smart.who.int/base/StructureDefinition/SGActorExt | |
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-GraphDefinition.node" | |
| extension:node/target |
1..1 | (Complex) | R5: Potential target for the link (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-GraphDefinition.node Constraints: ext-1 | |
| Slices for extension |
3..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:nodeId |
1..1 | Extension | R5: Internal ID - target for link references (new) Constraints: ext-1 | |
| url |
1..1 | uri | "nodeId" | |
| value[x] |
1..1 | id | Internal ID - target for link references Required Pattern: target (extensions allowed) | |
| extension:description |
0..1 | Extension | R5: Why this node is specified (new) Constraints: ext-1 | |
| url |
1..1 | uri | "description" | |
| extension:type |
1..1 | Extension | R5: Type of resource this link refers to (new) Constraints: ext-1 | |
| url |
1..1 | uri | "type" | |
| value[x] |
1..1 | code | Type of resource this link refers to Binding: R5VersionIndependentAllResourceTypesForR4 (0.1.0) (required): A type of resource, or a Reference (from all versions) Required Pattern: ActorDefinition (extensions allowed) | |
| extension:profile |
0..1 | Extension | R5: Profile for the target resource (new) Constraints: ext-1 | |
| url |
1..1 | uri | "profile" | |
| extension:actor |
1..* | Reference(SGActor) | Extension URL: http://smart.who.int/base/StructureDefinition/SGActorExt | |
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-GraphDefinition.node" | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| name |
C | 1..1 | string | Name for this graph definition (computer friendly) |
| status |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | |
| experimental |
1..1 | boolean | For testing purposes, not real usage | |
| description |
1..1 | markdown | Natural language description of the graph definition | |
| start |
1..1 | code | Type of resource at which the graph starts Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | |
| link |
1..1 | BackboneElement | Links this graph makes rules about | |
| Slices for extension |
7..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:sourceId |
0..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/LinkIdExt | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/LinkIdExt" | |
| value[x] |
0..1 | id | Value of extension Required Pattern: source (extensions allowed) | |
| extension:targetId |
0..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/LinkIdExt | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/LinkIdExt" | |
| value[x] |
0..1 | id | Value of extension Required Pattern: target (extensions allowed) | |
| extension:requestTrigger |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:code |
1..1 | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGcode | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGcode" | |
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| extension:doc |
1..1 | markdown | Extension URL: http://smart.who.int/base/StructureDefinition/SGMarkdown | |
| extension:requirements |
0..* | Reference(SMART Guidelines Requirements) | Extension URL: http://smart.who.int/base/StructureDefinition/SGRequirementExt | |
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGDocumentation" | |
| extension:requestSemantics |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:code |
1..1 | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGcode | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGcode" | |
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| extension:doc |
1..1 | markdown | Extension URL: http://smart.who.int/base/StructureDefinition/SGMarkdown | |
| extension:requirements |
0..* | Reference(SMART Guidelines Requirements) | Extension URL: http://smart.who.int/base/StructureDefinition/SGRequirementExt | |
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGDocumentation" | |
| extension:requestActions |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:code |
1..1 | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGcode | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGcode" | |
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| extension:doc |
1..1 | markdown | Extension URL: http://smart.who.int/base/StructureDefinition/SGMarkdown | |
| extension:requirements |
0..* | Reference(SMART Guidelines Requirements) | Extension URL: http://smart.who.int/base/StructureDefinition/SGRequirementExt | |
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGDocumentation" | |
| extension:responseTrigger |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:code |
1..1 | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGcode | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGcode" | |
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| extension:doc |
1..1 | markdown | Extension URL: http://smart.who.int/base/StructureDefinition/SGMarkdown | |
| extension:requirements |
0..* | Reference(SMART Guidelines Requirements) | Extension URL: http://smart.who.int/base/StructureDefinition/SGRequirementExt | |
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGDocumentation" | |
| extension:responseSemantics |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:code |
1..1 | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGcode | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGcode" | |
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| extension:doc |
1..1 | markdown | Extension URL: http://smart.who.int/base/StructureDefinition/SGMarkdown | |
| extension:requirements |
0..* | Reference(SMART Guidelines Requirements) | Extension URL: http://smart.who.int/base/StructureDefinition/SGRequirementExt | |
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGDocumentation" | |
| extension:responseActions |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:code |
1..1 | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGcode | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGcode" | |
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| extension:doc |
1..1 | markdown | Extension URL: http://smart.who.int/base/StructureDefinition/SGMarkdown | |
| extension:requirements |
0..* | Reference(SMART Guidelines Requirements) | Extension URL: http://smart.who.int/base/StructureDefinition/SGRequirementExt | |
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGDocumentation" | |
| extension:securityConsiderations |
1..1 | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:code |
1..1 | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGcode | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGcode" | |
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| extension:doc |
1..1 | markdown | Extension URL: http://smart.who.int/base/StructureDefinition/SGMarkdown | |
| extension:requirements |
0..* | Reference(SMART Guidelines Requirements) | Extension URL: http://smart.who.int/base/StructureDefinition/SGRequirementExt | |
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGDocumentation" | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| GraphDefinition.extension:node/source.extension:type.value[x] | Base | required | Cross-version ValueSet R5.VersionIndependentResourceTypesAll for use in FHIR R4 | 📍0.1.0 | Extensions for Using Data Elements from FHIR R5 in FHIR R4 v0.1 |
| GraphDefinition.extension:node/target.extension:type.value[x] | Base | required | Cross-version ValueSet R5.VersionIndependentResourceTypesAll for use in FHIR R4 | 📍0.1.0 | Extensions for Using Data Elements from FHIR R5 in FHIR R4 v0.1 |
| GraphDefinition.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| GraphDefinition.start | Base | required | ResourceType | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | GraphDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | GraphDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | GraphDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | GraphDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | GraphDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| gdf-0 | warning | GraphDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
Differential View
This structure is derived from SGGraphDefinition
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| GraphDefinition |
0..* | SGGraphDefinition | Definition of a graph of resources | |
| extension |
2..* | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| Slices for extension:node |
2..2 | R5 GraphDefinition.node | R5: Potential target for the link (new) Slice: Unordered, Closed by value:nodeId Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:node/source |
1..1 | R5 GraphDefinition.node | R5: Potential target for the link (new) | |
| extension |
3..* | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:nodeId |
1..1 | Extension | R5: Internal ID - target for link references (new) | |
| value[x] |
1..1 | id | Internal ID - target for link references Required Pattern: source (extensions allowed) | |
| extension:type |
1..1 | Extension | R5: Type of resource this link refers to (new) | |
| value[x] |
1..1 | code | Type of resource this link refers to Required Pattern: ActorDefinition (extensions allowed) | |
| extension:actor |
1..* | Reference(SGActor) | Extension URL: http://smart.who.int/base/StructureDefinition/SGActorExt | |
| extension:node/target |
1..1 | R5 GraphDefinition.node | R5: Potential target for the link (new) | |
| extension |
3..* | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:nodeId |
1..1 | Extension | R5: Internal ID - target for link references (new) | |
| value[x] |
1..1 | id | Internal ID - target for link references Required Pattern: target (extensions allowed) | |
| extension:type |
1..1 | Extension | R5: Type of resource this link refers to (new) | |
| value[x] |
1..1 | code | Type of resource this link refers to Required Pattern: ActorDefinition (extensions allowed) | |
| extension:actor |
1..* | Reference(SGActor) | Extension URL: http://smart.who.int/base/StructureDefinition/SGActorExt | |
| link |
1..1 | BackboneElement | Links this graph makes rules about | |
| extension |
7..* | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:sourceId |
0..* | LinkIdExt | Extension | |
| value[x] |
0..1 | id | Value of extension Required Pattern: source (extensions allowed) | |
| extension:targetId |
0..* | LinkIdExt | Extension | |
| value[x] |
0..1 | id | Value of extension Required Pattern: target (extensions allowed) | |
| extension:requestTrigger |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:code |
1..1 | SGcode | Extension | |
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |
| extension:requestSemantics |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:code |
1..1 | SGcode | Extension | |
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |
| extension:requestActions |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:code |
1..1 | SGcode | Extension | |
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |
| extension:responseTrigger |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:code |
1..1 | SGcode | Extension | |
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |
| extension:responseSemantics |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:code |
1..1 | SGcode | Extension | |
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |
| extension:responseActions |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:code |
1..1 | SGcode | Extension | |
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |
| extension:securityConsiderations |
1..1 | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:code |
1..1 | SGcode | Extension | |
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| GraphDefinition |
C | 0..* | SGGraphDefinition | Definition of a graph of resources Constraints: gdf-0 | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:node |
2..2 | (Complex) | R5: Potential target for the link (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-GraphDefinition.node Constraints: ext-1 | |||||
| extension:node/source |
1..1 | (Complex) | R5: Potential target for the link (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-GraphDefinition.node Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
3..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:nodeId |
1..1 | Extension | R5: Internal ID - target for link references (new) Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| url |
1..1 | uri | "nodeId" | |||||
| value[x] |
1..1 | id | Internal ID - target for link references Required Pattern: source (extensions allowed) | |||||
| extension:description |
0..1 | Extension | R5: Why this node is specified (new) Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| url |
1..1 | uri | "description" | |||||
| value[x] |
0..1 | string | Why this node is specified | |||||
| extension:type |
1..1 | Extension | R5: Type of resource this link refers to (new) Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| url |
1..1 | uri | "type" | |||||
| value[x] |
1..1 | code | Type of resource this link refers to Binding: R5VersionIndependentAllResourceTypesForR4 (0.1.0) (required): A type of resource, or a Reference (from all versions) Required Pattern: ActorDefinition (extensions allowed) | |||||
| extension:profile |
0..1 | Extension | R5: Profile for the target resource (new) Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| url |
1..1 | uri | "profile" | |||||
| value[x] |
0..1 | canonical(Cross-version Profile for R5.StructureDefinition for use in FHIR R4(0.1.0) | StructureDefinition) | Profile for the target resource | |||||
| extension:actor |
1..* | Reference(SGActor) | Extension URL: http://smart.who.int/base/StructureDefinition/SGActorExt | |||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-GraphDefinition.node" | |||||
| extension:node/target |
1..1 | (Complex) | R5: Potential target for the link (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-GraphDefinition.node Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
3..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:nodeId |
1..1 | Extension | R5: Internal ID - target for link references (new) Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| url |
1..1 | uri | "nodeId" | |||||
| value[x] |
1..1 | id | Internal ID - target for link references Required Pattern: target (extensions allowed) | |||||
| extension:description |
0..1 | Extension | R5: Why this node is specified (new) Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| url |
1..1 | uri | "description" | |||||
| value[x] |
0..1 | string | Why this node is specified | |||||
| extension:type |
1..1 | Extension | R5: Type of resource this link refers to (new) Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| url |
1..1 | uri | "type" | |||||
| value[x] |
1..1 | code | Type of resource this link refers to Binding: R5VersionIndependentAllResourceTypesForR4 (0.1.0) (required): A type of resource, or a Reference (from all versions) Required Pattern: ActorDefinition (extensions allowed) | |||||
| extension:profile |
0..1 | Extension | R5: Profile for the target resource (new) Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| url |
1..1 | uri | "profile" | |||||
| value[x] |
0..1 | canonical(Cross-version Profile for R5.StructureDefinition for use in FHIR R4(0.1.0) | StructureDefinition) | Profile for the target resource | |||||
| extension:actor |
1..* | Reference(SGActor) | Extension URL: http://smart.who.int/base/StructureDefinition/SGActorExt | |||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-GraphDefinition.node" | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| url |
0..1 | uri | Canonical identifier for this graph definition, represented as a URI (globally unique) | |||||
| version |
0..1 | string | Business version of the graph definition | |||||
| name |
C | 1..1 | string | Name for this graph definition (computer friendly) | ||||
| status |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | |||||
| experimental |
1..1 | boolean | For testing purposes, not real usage | |||||
| date |
0..1 | dateTime | Date last changed | |||||
| publisher |
0..1 | string | Name of the publisher (organization or individual) | |||||
| contact |
0..* | ContactDetail | Contact details for the publisher | |||||
| description |
1..1 | markdown | Natural language description of the graph definition | |||||
| useContext |
0..* | UsageContext | The context that the content is intended to support | |||||
| jurisdiction |
0..* | CodeableConcept | Intended jurisdiction for graph definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | |||||
| purpose |
0..1 | markdown | Why this graph definition is defined | |||||
| start |
1..1 | code | Type of resource at which the graph starts Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | |||||
| profile |
0..1 | canonical(StructureDefinition) | Profile on base resource | |||||
| link |
1..1 | BackboneElement | Links this graph makes rules about | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
7..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:sourceId |
0..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/LinkIdExt | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/LinkIdExt" | |||||
| value[x] |
0..1 | id | Value of extension Required Pattern: source (extensions allowed) | |||||
| extension:targetId |
0..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/LinkIdExt | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/LinkIdExt" | |||||
| value[x] |
0..1 | id | Value of extension Required Pattern: target (extensions allowed) | |||||
| extension:requestTrigger |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:code |
1..1 | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGcode | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGcode" | |||||
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| extension:doc |
1..1 | markdown | Extension URL: http://smart.who.int/base/StructureDefinition/SGMarkdown | |||||
| extension:requirements |
0..* | Reference(SMART Guidelines Requirements) | Extension URL: http://smart.who.int/base/StructureDefinition/SGRequirementExt | |||||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGDocumentation" | |||||
| extension:requestSemantics |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:code |
1..1 | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGcode | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGcode" | |||||
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| extension:doc |
1..1 | markdown | Extension URL: http://smart.who.int/base/StructureDefinition/SGMarkdown | |||||
| extension:requirements |
0..* | Reference(SMART Guidelines Requirements) | Extension URL: http://smart.who.int/base/StructureDefinition/SGRequirementExt | |||||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGDocumentation" | |||||
| extension:requestActions |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:code |
1..1 | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGcode | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGcode" | |||||
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| extension:doc |
1..1 | markdown | Extension URL: http://smart.who.int/base/StructureDefinition/SGMarkdown | |||||
| extension:requirements |
0..* | Reference(SMART Guidelines Requirements) | Extension URL: http://smart.who.int/base/StructureDefinition/SGRequirementExt | |||||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGDocumentation" | |||||
| extension:responseTrigger |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:code |
1..1 | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGcode | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGcode" | |||||
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| extension:doc |
1..1 | markdown | Extension URL: http://smart.who.int/base/StructureDefinition/SGMarkdown | |||||
| extension:requirements |
0..* | Reference(SMART Guidelines Requirements) | Extension URL: http://smart.who.int/base/StructureDefinition/SGRequirementExt | |||||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGDocumentation" | |||||
| extension:responseSemantics |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:code |
1..1 | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGcode | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGcode" | |||||
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| extension:doc |
1..1 | markdown | Extension URL: http://smart.who.int/base/StructureDefinition/SGMarkdown | |||||
| extension:requirements |
0..* | Reference(SMART Guidelines Requirements) | Extension URL: http://smart.who.int/base/StructureDefinition/SGRequirementExt | |||||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGDocumentation" | |||||
| extension:responseActions |
1..* | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:code |
1..1 | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGcode | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGcode" | |||||
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| extension:doc |
1..1 | markdown | Extension URL: http://smart.who.int/base/StructureDefinition/SGMarkdown | |||||
| extension:requirements |
0..* | Reference(SMART Guidelines Requirements) | Extension URL: http://smart.who.int/base/StructureDefinition/SGRequirementExt | |||||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGDocumentation" | |||||
| extension:securityConsiderations |
1..1 | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGDocumentation | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:code |
1..1 | (Complex) | Extension URL: http://smart.who.int/base/StructureDefinition/SGcode | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGcode" | |||||
| value[x] |
1..1 | Coding | Value of extension Required Pattern: | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| extension:doc |
1..1 | markdown | Extension URL: http://smart.who.int/base/StructureDefinition/SGMarkdown | |||||
| extension:requirements |
0..* | Reference(SMART Guidelines Requirements) | Extension URL: http://smart.who.int/base/StructureDefinition/SGRequirementExt | |||||
| url |
1..1 | uri | "http://smart.who.int/base/StructureDefinition/SGDocumentation" | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| path |
0..1 | string | Path in the resource that contains the link | |||||
| sliceName |
0..1 | string | Which slice (if profiled) | |||||
| min |
0..1 | integer | Minimum occurrences for this link | |||||
| max |
0..1 | string | Maximum occurrences for this link | |||||
| description |
0..1 | string | Why this link is specified | |||||
| target |
0..* | BackboneElement | Potential target for the link | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| type |
1..1 | code | Type of resource this link refers to Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | |||||
| params |
0..1 | string | Criteria for reverse lookup | |||||
| profile |
0..1 | canonical(StructureDefinition) | Profile for the target resource | |||||
| compartment |
0..* | BackboneElement | Compartment Consistency Rules | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| use |
1..1 | code | condition | requirement Binding: GraphCompartmentUse (required): Defines how a compartment rule is used. | |||||
| code |
1..1 | code | Patient | Encounter | RelatedPerson | Practitioner | Device Binding: CompartmentType (required): Identifies a compartment. | |||||
| rule |
1..1 | code | identical | matching | different | custom Binding: GraphCompartmentRule (required): How a compartment must be linked. | |||||
| expression |
0..1 | string | Custom rule, as a FHIRPath expression | |||||
| description |
0..1 | string | Documentation for FHIRPath expression | |||||
| link |
0..* | See link (GraphDefinition) | Additional links from target resource | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| GraphDefinition.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| GraphDefinition.extension:node/source.extension:type.value[x] | Base | required | Cross-version ValueSet R5.VersionIndependentResourceTypesAll for use in FHIR R4 | 📍0.1.0 | Extensions for Using Data Elements from FHIR R5 in FHIR R4 v0.1 |
| GraphDefinition.extension:node/target.extension:type.value[x] | Base | required | Cross-version ValueSet R5.VersionIndependentResourceTypesAll for use in FHIR R4 | 📍0.1.0 | Extensions for Using Data Elements from FHIR R5 in FHIR R4 v0.1 |
| GraphDefinition.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| GraphDefinition.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std. |
| GraphDefinition.start | Base | required | ResourceType | 📍4.0.1 | FHIR Std. |
| GraphDefinition.link.target.type | Base | required | ResourceType | 📍4.0.1 | FHIR Std. |
| GraphDefinition.link.target.compartment.use | Base | required | GraphCompartmentUse | 📍4.0.1 | FHIR Std. |
| GraphDefinition.link.target.compartment.code | Base | required | CompartmentType | 📍4.0.1 | FHIR Std. |
| GraphDefinition.link.target.compartment.rule | Base | required | GraphCompartmentRule | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | GraphDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | GraphDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | GraphDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | GraphDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | GraphDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| gdf-0 | warning | GraphDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
This structure is derived from SGGraphDefinition
Other representations of profile: CSV, Excel, Schematron