FHIR Clinical Guidelines (v1.0.0) (STU1)

This page is part of the Clinical Guidelines (v1.0.0: STU 1) based on FHIR R4. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition-cpg-shareablegraphdefinition

Introduction:

Examples:

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-shareablegraphdefinition

Profile of GraphDefinition to establish minimum expectations for sharing an GraphDefinition resource, including URL, version, and name. This profile also provides the ability to declare knowledge representation level and knowledge artifact capabilities.

This profile builds on GraphDefinition.

This profile was published on Thu Jun 06 00:00:00 UTC 2019 as a draft by Health Level Seven, Inc. - CDS WG.

Description of Profiles, Differentials, and Snapshots.

NameFlagsCard.TypeDescription & Constraintsdoco
.. GraphDefinition 0..*GraphDefinitionDefinition of a graph of resources
... cpg-knowledgeCapability S1..*codeshareable | computable | publishable | executable
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeCapability
Binding: CPG Knowledge Capability (required): A knowledge capability provided by a knowledge artifact


... cpg-knowledgeRepresentationLevel S0..*codenarrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeRepresentationLevel
Binding: CPG Knowledge Representation Level (required): A level of knowledge representation provided by this artifact


... cpg-identifier S0..*IdentifierBusiness identifier
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-identifier
... cpg-title S0..1stringName for this artifact (human friendly)
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-title
... url 1..1uriCanonical identifier for this graph definition, represented as a URI (globally unique)
... version 1..1stringBusiness version of the graph definition
... experimental 1..1booleanFor testing purposes, not real usage
... date S0..1dateTimeDate last changed
... publisher 1..1stringName of the publisher (organization or individual)
... contact S0..*ContactDetailContact details for the publisher
... description 1..1markdownNatural language description of the graph definition
... useContext S0..*UsageContextThe context that the content is intended to support
... jurisdiction S0..*CodeableConceptIntended jurisdiction for graph definition (if applicable)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. GraphDefinition I0..*GraphDefinitionDefinition of a graph of resources
... id Σ0..1stringLogical 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)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... cpg-knowledgeCapability S1..*codeshareable | computable | publishable | executable
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeCapability
Binding: CPG Knowledge Capability (required): A knowledge capability provided by a knowledge artifact


... cpg-knowledgeRepresentationLevel S0..*codenarrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeRepresentationLevel
Binding: CPG Knowledge Representation Level (required): A level of knowledge representation provided by this artifact


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

... experimental Σ1..1booleanFor testing purposes, not real usage
... date SΣ0..1dateTimeDate last changed
... publisher Σ1..1stringName of the publisher (organization or individual)
... contact SΣ0..*ContactDetailContact details for the publisher
... description 1..1markdownNatural language description of the graph definition
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ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

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. GraphDefinition 0..*GraphDefinitionDefinition of a graph of resources
... cpg-knowledgeCapability S1..*codeshareable | computable | publishable | executable
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeCapability
Binding: CPG Knowledge Capability (required): A knowledge capability provided by a knowledge artifact


... cpg-knowledgeRepresentationLevel S0..*codenarrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeRepresentationLevel
Binding: CPG Knowledge Representation Level (required): A level of knowledge representation provided by this artifact


... cpg-identifier S0..*IdentifierBusiness identifier
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-identifier
... cpg-title S0..1stringName for this artifact (human friendly)
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-title
... url 1..1uriCanonical identifier for this graph definition, represented as a URI (globally unique)
... version 1..1stringBusiness version of the graph definition
... experimental 1..1booleanFor testing purposes, not real usage
... date S0..1dateTimeDate last changed
... publisher 1..1stringName of the publisher (organization or individual)
... contact S0..*ContactDetailContact details for the publisher
... description 1..1markdownNatural language description of the graph definition
... useContext S0..*UsageContextThe context that the content is intended to support
... jurisdiction S0..*CodeableConceptIntended jurisdiction for graph definition (if applicable)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. GraphDefinition I0..*GraphDefinitionDefinition of a graph of resources
... id Σ0..1stringLogical 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)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... cpg-knowledgeCapability S1..*codeshareable | computable | publishable | executable
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeCapability
Binding: CPG Knowledge Capability (required): A knowledge capability provided by a knowledge artifact


... cpg-knowledgeRepresentationLevel S0..*codenarrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeRepresentationLevel
Binding: CPG Knowledge Representation Level (required): A level of knowledge representation provided by this artifact


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

... experimental Σ1..1booleanFor testing purposes, not real usage
... date SΣ0..1dateTimeDate last changed
... publisher Σ1..1stringName of the publisher (organization or individual)
... contact SΣ0..*ContactDetailContact details for the publisher
... description 1..1markdownNatural language description of the graph definition
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ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

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathConformanceValueSet
GraphDefinition.languagepreferredCommonLanguages
Max Binding: AllLanguages
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

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2GraphDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3GraphDefinitionIf 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-4GraphDefinitionIf 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-5GraphDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6GraphDefinitionA resource should have narrative for robust management
: text.`div`.exists()
gdf-0GraphDefinitionName 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}')
ele-1GraphDefinition.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1GraphDefinition.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1GraphDefinition.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1GraphDefinition.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1GraphDefinition.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1GraphDefinition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1GraphDefinition.extension:knowledgeCapabilityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1GraphDefinition.extension:knowledgeCapabilityMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1GraphDefinition.extension:knowledgeRepresentationLevelAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1GraphDefinition.extension:knowledgeRepresentationLevelMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1GraphDefinition.extension:identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1GraphDefinition.extension:identifierMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1GraphDefinition.extension:titleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1GraphDefinition.extension:titleMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1GraphDefinition.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1GraphDefinition.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1GraphDefinition.urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1GraphDefinition.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1GraphDefinition.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1GraphDefinition.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1GraphDefinition.experimentalAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1GraphDefinition.dateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1GraphDefinition.publisherAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1GraphDefinition.contactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1GraphDefinition.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1GraphDefinition.useContextAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1GraphDefinition.jurisdictionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1GraphDefinition.purposeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1GraphDefinition.startAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1GraphDefinition.profileAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1GraphDefinition.linkAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1GraphDefinition.link.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1GraphDefinition.link.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1GraphDefinition.link.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1GraphDefinition.link.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1GraphDefinition.link.pathAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1GraphDefinition.link.sliceNameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1GraphDefinition.link.minAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1GraphDefinition.link.maxAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1GraphDefinition.link.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1GraphDefinition.link.targetAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1GraphDefinition.link.target.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1GraphDefinition.link.target.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1GraphDefinition.link.target.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1GraphDefinition.link.target.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1GraphDefinition.link.target.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1GraphDefinition.link.target.paramsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1GraphDefinition.link.target.profileAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1GraphDefinition.link.target.compartmentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1GraphDefinition.link.target.compartment.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1GraphDefinition.link.target.compartment.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1GraphDefinition.link.target.compartment.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1GraphDefinition.link.target.compartment.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1GraphDefinition.link.target.compartment.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1GraphDefinition.link.target.compartment.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1GraphDefinition.link.target.compartment.ruleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1GraphDefinition.link.target.compartment.expressionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1GraphDefinition.link.target.compartment.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1GraphDefinition.link.target.linkAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())