Canonical Resource Management Infrastructure Implementation Guide
1.0.0-ballot - Ballot International flag

This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: CRMI Shareable GraphDefinition

Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablegraphdefinition Version: 1.0.0-ballot
Standards status: Trial-use Maturity Level: 3 Computable Name: CRMIShareableGraphDefinition

Enforces the minimum information set for the graph definition metadata required by HL7 and other organizations that share and publish graph definitions

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from GraphDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. GraphDefinition 1..1GraphDefinitionDefinition of a graph of resources
... knowledgeCapability S0..*codeshareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapabilityValues (required)
... knowledgeRepresentationLevel S0..*codenarrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: KnowledgeRepresentationLevelValues (required)
... artifactComment S0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
... versionPolicy S0..1Codingmetadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy Values (extensible): The versioning policy of the artifact

... title S1..1stringName for this {{title}} (human friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
... url S1..1uriCanonical identifier for this graph definition, represented as a URI (globally unique)
... version S1..1stringBusiness version of the graph definition
... name S1..1stringName for this graph definition (computer friendly)
... status S1..1codedraft | active | retired | unknown
... experimental S1..1booleanFor testing purposes, not real usage
... publisher S0..1stringName of the publisher (organization or individual)
... description S1..1markdownNatural language description of the graph definition

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. GraphDefinition C1..1GraphDefinitionDefinition of a graph of resources
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... knowledgeCapability S0..*codeshareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapabilityValues (required)
... artifactComment S0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
... versionAlgorithm S0..1string, CodingHow to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible): The algorithm used to compare versions for the artifact


... versionPolicy S0..1Codingmetadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy Values (extensible): The versioning policy of the artifact


... title S1..1stringName for this {{title}} (human friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriCanonical identifier for this graph definition, represented as a URI (globally unique)
... version SΣ1..1stringBusiness version of the graph definition
... name SΣC1..1stringName for this graph definition (computer friendly)
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental SΣ1..1booleanFor testing purposes, not real usage
... publisher SΣ0..1stringName of the publisher (organization or individual)
... description S1..1markdownNatural language description of the graph definition
... start Σ1..1codeType of resource at which the graph starts
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
GraphDefinition.statusrequiredPublicationStatus
GraphDefinition.startrequiredResourceType

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGraphDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGraphDefinitionIf 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-4errorGraphDefinitionIf 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-5errorGraphDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGraphDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
gdf-0warningGraphDefinitionName 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}')
NameFlagsCard.TypeDescription & Constraintsdoco
.. GraphDefinition C1..1GraphDefinitionDefinition of a graph of resources
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... knowledgeCapability S0..*codeshareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapabilityValues (required)
... knowledgeRepresentationLevel S0..*codenarrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: KnowledgeRepresentationLevelValues (required)
... artifactComment S0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
... versionAlgorithm S0..1string, CodingHow to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible): The algorithm used to compare versions for the artifact


... versionPolicy S0..1Codingmetadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy Values (extensible): The versioning policy of the artifact


... title S1..1stringName for this {{title}} (human friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriCanonical identifier for this graph definition, represented as a URI (globally unique)
... version SΣ1..1stringBusiness version of the graph definition
... name SΣC1..1stringName for this graph definition (computer friendly)
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental SΣ1..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher SΣ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description S1..1markdownNatural language description of the graph definition
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for graph definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this graph definition is defined
... start Σ1..1codeType 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..1canonical(StructureDefinition)Profile on base resource
... link 0..*BackboneElementLinks this graph makes rules about
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... path 0..1stringPath in the resource that contains the link
.... sliceName 0..1stringWhich slice (if profiled)
.... min 0..1integerMinimum occurrences for this link
.... max 0..1stringMaximum occurrences for this link
.... description 0..1stringWhy this link is specified
.... target 0..*BackboneElementPotential target for the link
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1codeType of resource this link refers to
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.

..... params 0..1stringCriteria for reverse lookup
..... profile 0..1canonical(StructureDefinition)Profile for the target resource
..... compartment 0..*BackboneElementCompartment Consistency Rules
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... use 1..1codecondition | requirement
Binding: GraphCompartmentUse (required): Defines how a compartment rule is used.

...... code 1..1codePatient | Encounter | RelatedPerson | Practitioner | Device
Binding: CompartmentType (required): Identifies a compartment.

...... rule 1..1codeidentical | matching | different | custom
Binding: GraphCompartmentRule (required): How a compartment must be linked.

...... expression 0..1stringCustom rule, as a FHIRPath expression
...... description 0..1stringDocumentation for FHIRPath expression
..... link 0..*See link (GraphDefinition)Additional links from target resource

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
GraphDefinition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
GraphDefinition.statusrequiredPublicationStatus
GraphDefinition.jurisdictionextensibleJurisdiction ValueSet
GraphDefinition.startrequiredResourceType
GraphDefinition.link.target.typerequiredResourceType
GraphDefinition.link.target.compartment.userequiredGraphCompartmentUse
GraphDefinition.link.target.compartment.coderequiredCompartmentType
GraphDefinition.link.target.compartment.rulerequiredGraphCompartmentRule

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from GraphDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. GraphDefinition 1..1GraphDefinitionDefinition of a graph of resources
... knowledgeCapability S0..*codeshareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapabilityValues (required)
... knowledgeRepresentationLevel S0..*codenarrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: KnowledgeRepresentationLevelValues (required)
... artifactComment S0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
... versionPolicy S0..1Codingmetadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy Values (extensible): The versioning policy of the artifact

... title S1..1stringName for this {{title}} (human friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
... url S1..1uriCanonical identifier for this graph definition, represented as a URI (globally unique)
... version S1..1stringBusiness version of the graph definition
... name S1..1stringName for this graph definition (computer friendly)
... status S1..1codedraft | active | retired | unknown
... experimental S1..1booleanFor testing purposes, not real usage
... publisher S0..1stringName of the publisher (organization or individual)
... description S1..1markdownNatural language description of the graph definition

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. GraphDefinition C1..1GraphDefinitionDefinition of a graph of resources
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... knowledgeCapability S0..*codeshareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapabilityValues (required)
... artifactComment S0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
... versionAlgorithm S0..1string, CodingHow to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible): The algorithm used to compare versions for the artifact


... versionPolicy S0..1Codingmetadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy Values (extensible): The versioning policy of the artifact


... title S1..1stringName for this {{title}} (human friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriCanonical identifier for this graph definition, represented as a URI (globally unique)
... version SΣ1..1stringBusiness version of the graph definition
... name SΣC1..1stringName for this graph definition (computer friendly)
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental SΣ1..1booleanFor testing purposes, not real usage
... publisher SΣ0..1stringName of the publisher (organization or individual)
... description S1..1markdownNatural language description of the graph definition
... start Σ1..1codeType of resource at which the graph starts
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
GraphDefinition.statusrequiredPublicationStatus
GraphDefinition.startrequiredResourceType

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGraphDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGraphDefinitionIf 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-4errorGraphDefinitionIf 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-5errorGraphDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGraphDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
gdf-0warningGraphDefinitionName 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. GraphDefinition C1..1GraphDefinitionDefinition of a graph of resources
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... knowledgeCapability S0..*codeshareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapabilityValues (required)
... knowledgeRepresentationLevel S0..*codenarrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: KnowledgeRepresentationLevelValues (required)
... artifactComment S0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
... versionAlgorithm S0..1string, CodingHow to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible): The algorithm used to compare versions for the artifact


... versionPolicy S0..1Codingmetadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy Values (extensible): The versioning policy of the artifact


... title S1..1stringName for this {{title}} (human friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriCanonical identifier for this graph definition, represented as a URI (globally unique)
... version SΣ1..1stringBusiness version of the graph definition
... name SΣC1..1stringName for this graph definition (computer friendly)
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental SΣ1..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher SΣ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description S1..1markdownNatural language description of the graph definition
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for graph definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this graph definition is defined
... start Σ1..1codeType 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..1canonical(StructureDefinition)Profile on base resource
... link 0..*BackboneElementLinks this graph makes rules about
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... path 0..1stringPath in the resource that contains the link
.... sliceName 0..1stringWhich slice (if profiled)
.... min 0..1integerMinimum occurrences for this link
.... max 0..1stringMaximum occurrences for this link
.... description 0..1stringWhy this link is specified
.... target 0..*BackboneElementPotential target for the link
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1codeType of resource this link refers to
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.

..... params 0..1stringCriteria for reverse lookup
..... profile 0..1canonical(StructureDefinition)Profile for the target resource
..... compartment 0..*BackboneElementCompartment Consistency Rules
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... use 1..1codecondition | requirement
Binding: GraphCompartmentUse (required): Defines how a compartment rule is used.

...... code 1..1codePatient | Encounter | RelatedPerson | Practitioner | Device
Binding: CompartmentType (required): Identifies a compartment.

...... rule 1..1codeidentical | matching | different | custom
Binding: GraphCompartmentRule (required): How a compartment must be linked.

...... expression 0..1stringCustom rule, as a FHIRPath expression
...... description 0..1stringDocumentation for FHIRPath expression
..... link 0..*See link (GraphDefinition)Additional links from target resource

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
GraphDefinition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
GraphDefinition.statusrequiredPublicationStatus
GraphDefinition.jurisdictionextensibleJurisdiction ValueSet
GraphDefinition.startrequiredResourceType
GraphDefinition.link.target.typerequiredResourceType
GraphDefinition.link.target.compartment.userequiredGraphCompartmentUse
GraphDefinition.link.target.compartment.coderequiredCompartmentType
GraphDefinition.link.target.compartment.rulerequiredGraphCompartmentRule

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron