Canonical Resource Management Infrastructure Implementation Guide
1.0.0 - STU1
Canonical Resource Management Infrastructure Implementation Guide
1.0.0 - STU1
This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0: STU1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablegraphdefinition | Version: 1.0.0 | |||
| Standards status: Trial-use | Maturity Level: 3 | Computable Name: CRMIPublishableGraphDefinition | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.42.34 | ||||
Supports declaration of the GraphDefinition metadata required by HL7 and other organizations that share and publish graph definitions with a focus on the aspects of that metadata that are important for post-publication activities including distribution, inclusion in repositories, consumption, and implementation.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from GraphDefinition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  GraphDefinition |
C | 1..1 | GraphDefinition | Definition of a graph of resources gdf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
Content/Rules for all slices | |||
   identifier |
S | 0..* | Identifier | Additional identifier for the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier |
| usage |
S | 0..1 | markdown | Describes the clinical usage of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-usage |
| copyright |
S | 0..1 | markdown | Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright |
| copyrightLabel |
S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel |
| approvalDate |
S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate |
| lastReviewDate |
S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate |
| effectivePeriod |
S | 0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod |
| topic |
S | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact |
| author |
S | 0..* | ContactDetail | Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author |
| editor |
S | 0..* | ContactDetail | Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor |
| reviewer |
S | 0..* | ContactDetail | Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer |
| endorser |
S | 0..* | ContactDetail | Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser |
 relatedArtifact |
S | 0..* | RelatedArtifact | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact |
 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. |
| date |
SΣ | 1..1 | dateTime | Date last changed |
 contact |
SΣ | 0..* | ContactDetail | Contact details for the publisher |
| useContext |
SΣ | 0..* | UsageContext | The context that the content is intended to support |
| jurisdiction |
SΣ | 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 |
S | 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. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| GraphDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | |
| GraphDefinition.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | |
| GraphDefinition.start | required | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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}') |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| GraphDefinition |
C | 1..1 | GraphDefinition | Definition of a graph of resources gdf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation | ||||
| 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 | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| identifier |
S | 0..* | Identifier | Additional identifier for the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier | ||||
| usage |
S | 0..1 | markdown | Describes the clinical usage of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-usage | ||||
| copyright |
S | 0..1 | markdown | Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright | ||||
| copyrightLabel |
S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel | ||||
| approvalDate |
S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate | ||||
| lastReviewDate |
S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate | ||||
| effectivePeriod |
S | 0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod | ||||
| topic |
S | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact | ||||
| author |
S | 0..* | ContactDetail | Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author | ||||
| editor |
S | 0..* | ContactDetail | Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor | ||||
| reviewer |
S | 0..* | ContactDetail | Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer | ||||
| endorser |
S | 0..* | ContactDetail | Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser | ||||
| relatedArtifact |
S | 0..* | RelatedArtifact | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact | ||||
| 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 |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| date |
SΣ | 1..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
SΣ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
0..1 | markdown | Natural language description of the graph definition | |||||
| useContext |
SΣ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction |
SΣ | 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 |
S | 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 | Conformance | ValueSet | URI | |||
| GraphDefinition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| GraphDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | ||||
| GraphDefinition.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | ||||
| GraphDefinition.start | required | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1from the FHIR Standard | ||||
| GraphDefinition.link.target.type | required | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1from the FHIR Standard | ||||
| GraphDefinition.link.target.compartment.use | required | GraphCompartmentUsehttp://hl7.org/fhir/ValueSet/graph-compartment-use|4.0.1from the FHIR Standard | ||||
| GraphDefinition.link.target.compartment.code | required | CompartmentTypehttp://hl7.org/fhir/ValueSet/compartment-type|4.0.1from the FHIR Standard | ||||
| GraphDefinition.link.target.compartment.rule | required | GraphCompartmentRulehttp://hl7.org/fhir/ValueSet/graph-compartment-rule|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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: 1 element
Must-Support: 18 elements
Extensions
This structure refers to these extensions:
Maturity: 3
Differential View
This structure is derived from GraphDefinition
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| GraphDefinition |
C | 1..1 | GraphDefinition | Definition of a graph of resources gdf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
Content/Rules for all slices | |||
| identifier |
S | 0..* | Identifier | Additional identifier for the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier |
| usage |
S | 0..1 | markdown | Describes the clinical usage of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-usage |
| copyright |
S | 0..1 | markdown | Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright |
| copyrightLabel |
S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel |
| approvalDate |
S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate |
| lastReviewDate |
S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate |
| effectivePeriod |
S | 0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod |
| topic |
S | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact |
| author |
S | 0..* | ContactDetail | Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author |
| editor |
S | 0..* | ContactDetail | Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor |
| reviewer |
S | 0..* | ContactDetail | Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer |
| endorser |
S | 0..* | ContactDetail | Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser |
| relatedArtifact |
S | 0..* | RelatedArtifact | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact |
| 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. |
| date |
SΣ | 1..1 | dateTime | Date last changed |
| contact |
SΣ | 0..* | ContactDetail | Contact details for the publisher |
| useContext |
SΣ | 0..* | UsageContext | The context that the content is intended to support |
| jurisdiction |
SΣ | 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 |
S | 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. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| GraphDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | |
| GraphDefinition.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | |
| GraphDefinition.start | required | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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}') |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| GraphDefinition |
C | 1..1 | GraphDefinition | Definition of a graph of resources gdf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation | ||||
| 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 | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| identifier |
S | 0..* | Identifier | Additional identifier for the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier | ||||
| usage |
S | 0..1 | markdown | Describes the clinical usage of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-usage | ||||
| copyright |
S | 0..1 | markdown | Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright | ||||
| copyrightLabel |
S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel | ||||
| approvalDate |
S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate | ||||
| lastReviewDate |
S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate | ||||
| effectivePeriod |
S | 0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod | ||||
| topic |
S | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact | ||||
| author |
S | 0..* | ContactDetail | Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author | ||||
| editor |
S | 0..* | ContactDetail | Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor | ||||
| reviewer |
S | 0..* | ContactDetail | Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer | ||||
| endorser |
S | 0..* | ContactDetail | Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser | ||||
| relatedArtifact |
S | 0..* | RelatedArtifact | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact | ||||
| 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 |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| date |
SΣ | 1..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
SΣ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
0..1 | markdown | Natural language description of the graph definition | |||||
| useContext |
SΣ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction |
SΣ | 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 |
S | 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 | Conformance | ValueSet | URI | |||
| GraphDefinition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| GraphDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | ||||
| GraphDefinition.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | ||||
| GraphDefinition.start | required | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1from the FHIR Standard | ||||
| GraphDefinition.link.target.type | required | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1from the FHIR Standard | ||||
| GraphDefinition.link.target.compartment.use | required | GraphCompartmentUsehttp://hl7.org/fhir/ValueSet/graph-compartment-use|4.0.1from the FHIR Standard | ||||
| GraphDefinition.link.target.compartment.code | required | CompartmentTypehttp://hl7.org/fhir/ValueSet/compartment-type|4.0.1from the FHIR Standard | ||||
| GraphDefinition.link.target.compartment.rule | required | GraphCompartmentRulehttp://hl7.org/fhir/ValueSet/graph-compartment-rule|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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: 1 element
Must-Support: 18 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#1.0.0 based on FHIR 4.0.1. Generated 2024-05-31
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change