Canonical Resource Management Infrastructure Implementation Guide
2.0.0-ballot - STU 2 - Ballot
Canonical Resource Management Infrastructure Implementation Guide
2.0.0-ballot - STU 2 - Ballot
Canonical Resource Management Infrastructure Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/crmi-ig/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablegraphdefinition | Version: 2.0.0-ballot | |||
| Standards status: Trial-use | Maturity Level: 3 | Computable Name: CRMIShareableGraphDefinition | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.42.49 | ||||
Enforces the minimum information set for the graph definition metadata required by HL7 and other organizations that share and publish graph definitions
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  GraphDefinition |
C | 1..1 | GraphDefinition | 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 |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:knowledgeCapability |
S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) |
| extension:versionAlgorithm |
S | 0..1 | Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) |
| extension:versionPolicy |
0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: ValueSet Artifact Version Policy (extensible): The versioning policy of the artifact | |
 extension:title |
S | 1..1 | string | Name for this artifact (human friendly) URL: http://hl7.org/fhir/StructureDefinition/artifact-title |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| url |
SΣ | 1..1 | uri | Canonical identifier for this graph definition, represented as a URI (globally unique) |
| version |
SΣ | 1..1 | string | Business version of the graph definition |
| name |
SΣC | 1..1 | string | Name for this graph definition (computer friendly) |
| status |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| experimental |
SΣ | 1..1 | boolean | For testing purposes, not real usage |
| publisher |
SΣ | 0..1 | string | Name of the publisher (organization or individual) |
| description |
S | 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. |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| GraphDefinition.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| GraphDefinition.start | Base | required | ResourceType | 📍4.0.1 | FHIR Std. |
| 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 GraphDefinition
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| GraphDefinition |
1..1 | GraphDefinition | Definition of a graph of resources | |
 Slices for extension |
Content/Rules for all slices | |||
| extension:knowledgeCapability |
S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) |
| extension:versionAlgorithm |
S | 0..1 | Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) |
| extension:versionPolicy |
0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: ValueSet Artifact Version Policy (extensible): The versioning policy of the artifact | |
| extension:title |
S | 1..1 | string | Name for this artifact (human friendly) URL: http://hl7.org/fhir/StructureDefinition/artifact-title |
 url |
S | 1..1 | uri | Canonical identifier for this graph definition, represented as a URI (globally unique) |
| version |
S | 1..1 | string | Business version of the graph definition |
| name |
S | 1..1 | string | Name for this graph definition (computer friendly) |
| status |
S | 1..1 | code | draft | active | retired | unknown |
| experimental |
S | 1..1 | boolean | For testing purposes, not real usage |
| publisher |
S | 0..1 | string | Name of the publisher (organization or individual) |
| description |
S | 1..1 | markdown | Natural language description of the graph definition |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| GraphDefinition |
C | 1..1 | GraphDefinition | 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 |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:knowledgeCapability |
S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) | ||||
| extension:versionAlgorithm |
S | 0..1 | Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) | ||||
| extension:versionPolicy |
0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: ValueSet Artifact Version Policy (extensible): The versioning policy of the artifact | |||||
| extension:title |
S | 1..1 | string | Name for this artifact (human friendly) URL: http://hl7.org/fhir/StructureDefinition/artifact-title | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url |
SΣ | 1..1 | uri | Canonical identifier for this graph definition, represented as a URI (globally unique) | ||||
| version |
SΣ | 1..1 | string | Business version of the graph definition | ||||
| name |
SΣC | 1..1 | string | Name for this graph definition (computer friendly) | ||||
| status |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
SΣ | 1..1 | boolean | For testing purposes, not real usage | ||||
| date |
Σ | 0..1 | dateTime | Date last changed | ||||
| publisher |
SΣ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
S | 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 |
0..* | BackboneElement | Links this graph makes rules about | |||||
 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 | ||||
| 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 | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| GraphDefinition.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| 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. |
| 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 GraphDefinition
Summary
Mandatory: 5 elements
Must-Support: 10 elements
Extensions
This structure refers to these extensions:
Maturity: 3
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| GraphDefinition |
C | 1..1 | GraphDefinition | 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 |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:knowledgeCapability |
S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) |
| extension:versionAlgorithm |
S | 0..1 | Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) |
| extension:versionPolicy |
0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: ValueSet Artifact Version Policy (extensible): The versioning policy of the artifact | |
| extension:title |
S | 1..1 | string | Name for this artifact (human friendly) URL: http://hl7.org/fhir/StructureDefinition/artifact-title |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| url |
SΣ | 1..1 | uri | Canonical identifier for this graph definition, represented as a URI (globally unique) |
| version |
SΣ | 1..1 | string | Business version of the graph definition |
| name |
SΣC | 1..1 | string | Name for this graph definition (computer friendly) |
| status |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| experimental |
SΣ | 1..1 | boolean | For testing purposes, not real usage |
| publisher |
SΣ | 0..1 | string | Name of the publisher (organization or individual) |
| description |
S | 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. |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| GraphDefinition.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| GraphDefinition.start | Base | required | ResourceType | 📍4.0.1 | FHIR Std. |
| 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 GraphDefinition
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| GraphDefinition |
1..1 | GraphDefinition | Definition of a graph of resources | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:knowledgeCapability |
S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) |
| extension:versionAlgorithm |
S | 0..1 | Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) |
| extension:versionPolicy |
0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: ValueSet Artifact Version Policy (extensible): The versioning policy of the artifact | |
| extension:title |
S | 1..1 | string | Name for this artifact (human friendly) URL: http://hl7.org/fhir/StructureDefinition/artifact-title |
| url |
S | 1..1 | uri | Canonical identifier for this graph definition, represented as a URI (globally unique) |
| version |
S | 1..1 | string | Business version of the graph definition |
| name |
S | 1..1 | string | Name for this graph definition (computer friendly) |
| status |
S | 1..1 | code | draft | active | retired | unknown |
| experimental |
S | 1..1 | boolean | For testing purposes, not real usage |
| publisher |
S | 0..1 | string | Name of the publisher (organization or individual) |
| description |
S | 1..1 | markdown | Natural language description of the graph definition |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| GraphDefinition |
C | 1..1 | GraphDefinition | 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 |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:knowledgeCapability |
S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) | ||||
| extension:versionAlgorithm |
S | 0..1 | Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) | ||||
| extension:versionPolicy |
0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: ValueSet Artifact Version Policy (extensible): The versioning policy of the artifact | |||||
| extension:title |
S | 1..1 | string | Name for this artifact (human friendly) URL: http://hl7.org/fhir/StructureDefinition/artifact-title | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url |
SΣ | 1..1 | uri | Canonical identifier for this graph definition, represented as a URI (globally unique) | ||||
| version |
SΣ | 1..1 | string | Business version of the graph definition | ||||
| name |
SΣC | 1..1 | string | Name for this graph definition (computer friendly) | ||||
| status |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
SΣ | 1..1 | boolean | For testing purposes, not real usage | ||||
| date |
Σ | 0..1 | dateTime | Date last changed | ||||
| publisher |
SΣ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
S | 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 |
0..* | BackboneElement | Links this graph makes rules about | |||||
| 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 | ||||
| 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 | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| GraphDefinition.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| 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. |
| 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 GraphDefinition
Summary
Mandatory: 5 elements
Must-Support: 10 elements
Extensions
This structure refers to these extensions:
Maturity: 3
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 International / Clinical Decision Support. Package hl7.fhir.uv.crmi#2.0.0-ballot based on FHIR 4.0.1. Generated 2025-10-06
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change