Content Repository Management Infrastructure Implementation Guide
3.0.0-ballot - STU 3 Ballot International flag

Content Repository 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 3.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

Resource Profile: CRMI Publishable GraphDefinition

Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablegraphdefinition Version: 3.0.0-ballot
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.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
GraphDefinition C 1..1 GraphDefinition Definition of a graph of resources
Constraints: gdf-0, pub-1
GraphDefinition.meta This element is included in summaries. 0..1 Meta Metadata about the resource
GraphDefinition.meta.Slices for extension Content/Rules for all slices
GraphDefinition.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
GraphDefinition.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
GraphDefinition.Slices for extension Content/Rules for all slices
GraphDefinition.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
GraphDefinition.Slices for extension.extension:identifier This element must be supported. 0..* Identifier Additional identifier for the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
GraphDefinition.Slices for extension.extension:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
GraphDefinition.Slices for extension.extension:copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
GraphDefinition.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
GraphDefinition.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
GraphDefinition.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
GraphDefinition.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
GraphDefinition.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
GraphDefinition.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
GraphDefinition.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
GraphDefinition.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
GraphDefinition.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
GraphDefinition.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
GraphDefinition.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
GraphDefinition.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
GraphDefinition.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
GraphDefinition.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
GraphDefinition.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
GraphDefinition.name This element is included in summaries. C 1..1 string Name for this graph definition (computer friendly)
GraphDefinition.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
GraphDefinition.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
GraphDefinition.contact This element must be supported. This element is included in summaries. 0..* ContactDetail Contact details for the publisher
GraphDefinition.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
GraphDefinition.jurisdiction This element must be supported. This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for graph definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
GraphDefinition.purpose This element must be supported. 0..1 markdown Why this graph definition is defined
GraphDefinition.start This element is included in summaries. 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
GraphDefinition.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍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.

Constraints

Id Grade Path(s) Description Expression
dom-2 error GraphDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error GraphDefinition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error GraphDefinition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error GraphDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice GraphDefinition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
gdf-0 warning GraphDefinition Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
pub-1 error GraphDefinition If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

This structure is derived from GraphDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: doco
GraphDefinition C 1..1 GraphDefinition Definition of a graph of resources
Constraints: pub-1
GraphDefinition.meta
GraphDefinition.meta.Slices for extension Content/Rules for all slices
GraphDefinition.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
GraphDefinition.Slices for extension Content/Rules for all slices
GraphDefinition.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
GraphDefinition.Slices for extension.extension:identifier This element must be supported. 0..* Identifier Additional identifier for the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
GraphDefinition.Slices for extension.extension:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
GraphDefinition.Slices for extension.extension:copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
GraphDefinition.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
GraphDefinition.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
GraphDefinition.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
GraphDefinition.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
GraphDefinition.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
GraphDefinition.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
GraphDefinition.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
GraphDefinition.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
GraphDefinition.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
GraphDefinition.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
GraphDefinition.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x]
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
GraphDefinition.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
GraphDefinition.date This element must be supported. 1..1 dateTime Date last changed
GraphDefinition.useContext This element must be supported. 0..* UsageContext The context that the content is intended to support
GraphDefinition.jurisdiction This element must be supported. 0..* CodeableConcept Intended jurisdiction for graph definition (if applicable)
GraphDefinition.purpose This element must be supported. 0..1 markdown Why this graph definition is defined

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
pub-1 error GraphDefinition If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
NameFlagsCard.TypeDescription & Constraints    Filter: doco
GraphDefinition C 1..1 GraphDefinition Definition of a graph of resources
Constraints: gdf-0, pub-1
GraphDefinition.id This element is included in summaries. 0..1 id Logical id of this artifact
GraphDefinition.meta This element is included in summaries. 0..1 Meta Metadata about the resource
GraphDefinition.meta.id 0..1 string Unique id for inter-element referencing
GraphDefinition.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
GraphDefinition.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
GraphDefinition.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
GraphDefinition.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
GraphDefinition.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
GraphDefinition.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
GraphDefinition.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
GraphDefinition.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
GraphDefinition.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
GraphDefinition.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
GraphDefinition.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
GraphDefinition.contained 0..* Resource Contained, inline Resources
GraphDefinition.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
GraphDefinition.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
GraphDefinition.Slices for extension.extension:identifier This element must be supported. 0..* Identifier Additional identifier for the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
GraphDefinition.Slices for extension.extension:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
GraphDefinition.Slices for extension.extension:copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
GraphDefinition.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
GraphDefinition.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
GraphDefinition.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
GraphDefinition.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
GraphDefinition.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
GraphDefinition.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
GraphDefinition.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
GraphDefinition.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
GraphDefinition.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
GraphDefinition.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
GraphDefinition.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
GraphDefinition.Slices for extension.extension:relatedArtifact.id 0..1 string Unique id for inter-element referencing
GraphDefinition.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
GraphDefinition.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].id 0..1 string Unique id for inter-element referencing
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].label This element is included in summaries. 0..1 string Short label
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].display This element is included in summaries. 0..1 string Brief description of the related artifact
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].citation This element is included in summaries. 0..1 markdown Bibliographic citation for the artifact
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].url This element is included in summaries. 0..1 url Where the artifact can be accessed
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].document This element is included in summaries. 0..1 Attachment What document is being referenced
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].resource This element is included in summaries. 0..1 canonical(Resource) What resource is being referenced
GraphDefinition.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
GraphDefinition.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
GraphDefinition.url This element is included in summaries. 0..1 uri Canonical identifier for this graph definition, represented as a URI (globally unique)
GraphDefinition.version This element is included in summaries. 0..1 string Business version of the graph definition
GraphDefinition.name This element is included in summaries. C 1..1 string Name for this graph definition (computer friendly)
GraphDefinition.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
GraphDefinition.experimental This element is included in summaries. 0..1 boolean For testing purposes, not real usage
GraphDefinition.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
GraphDefinition.publisher This element is included in summaries. 0..1 string Name of the publisher (organization or individual)
GraphDefinition.contact This element must be supported. This element is included in summaries. 0..* ContactDetail Contact details for the publisher
GraphDefinition.description 0..1 markdown Natural language description of the graph definition
GraphDefinition.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
GraphDefinition.jurisdiction This element must be supported. This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for graph definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
GraphDefinition.purpose This element must be supported. 0..1 markdown Why this graph definition is defined
GraphDefinition.start This element is included in summaries. 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.
GraphDefinition.profile 0..1 canonical(StructureDefinition) Profile on base resource
GraphDefinition.link 0..* BackboneElement Links this graph makes rules about
GraphDefinition.link.id 0..1 string Unique id for inter-element referencing
GraphDefinition.link.extension 0..* Extension Additional content defined by implementations
GraphDefinition.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
GraphDefinition.link.path 0..1 string Path in the resource that contains the link
GraphDefinition.link.sliceName 0..1 string Which slice (if profiled)
GraphDefinition.link.min 0..1 integer Minimum occurrences for this link
GraphDefinition.link.max 0..1 string Maximum occurrences for this link
GraphDefinition.link.description 0..1 string Why this link is specified
GraphDefinition.link.target 0..* BackboneElement Potential target for the link
GraphDefinition.link.target.id 0..1 string Unique id for inter-element referencing
GraphDefinition.link.target.extension 0..* Extension Additional content defined by implementations
GraphDefinition.link.target.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
GraphDefinition.link.target.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.
GraphDefinition.link.target.params 0..1 string Criteria for reverse lookup
GraphDefinition.link.target.profile 0..1 canonical(StructureDefinition) Profile for the target resource
GraphDefinition.link.target.compartment 0..* BackboneElement Compartment Consistency Rules
GraphDefinition.link.target.compartment.id 0..1 string Unique id for inter-element referencing
GraphDefinition.link.target.compartment.extension 0..* Extension Additional content defined by implementations
GraphDefinition.link.target.compartment.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
GraphDefinition.link.target.compartment.use 1..1 code condition | requirement
Binding: GraphCompartmentUse (required): Defines how a compartment rule is used.
GraphDefinition.link.target.compartment.code 1..1 code Patient | Encounter | RelatedPerson | Practitioner | Device
Binding: CompartmentType (required): Identifies a compartment.
GraphDefinition.link.target.compartment.rule 1..1 code identical | matching | different | custom
Binding: GraphCompartmentRule (required): How a compartment must be linked.
GraphDefinition.link.target.compartment.expression 0..1 string Custom rule, as a FHIRPath expression
GraphDefinition.link.target.compartment.description 0..1 string Documentation for FHIRPath expression
GraphDefinition.link.target.link 0..* See link (GraphDefinition) Additional links from target resource

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
GraphDefinition.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
GraphDefinition.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
GraphDefinition.language Base preferred Common Languages 📍4.0.1 FHIR Std.
GraphDefinition.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍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.

Constraints

Id Grade Path(s) Description Expression
dom-2 error GraphDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error GraphDefinition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error GraphDefinition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error GraphDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice GraphDefinition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
gdf-0 warning GraphDefinition Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
pub-1 error GraphDefinition If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
GraphDefinition C 1..1 GraphDefinition Definition of a graph of resources
Constraints: gdf-0, pub-1
GraphDefinition.meta This element is included in summaries. 0..1 Meta Metadata about the resource
GraphDefinition.meta.Slices for extension Content/Rules for all slices
GraphDefinition.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
GraphDefinition.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
GraphDefinition.Slices for extension Content/Rules for all slices
GraphDefinition.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
GraphDefinition.Slices for extension.extension:identifier This element must be supported. 0..* Identifier Additional identifier for the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
GraphDefinition.Slices for extension.extension:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
GraphDefinition.Slices for extension.extension:copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
GraphDefinition.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
GraphDefinition.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
GraphDefinition.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
GraphDefinition.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
GraphDefinition.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
GraphDefinition.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
GraphDefinition.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
GraphDefinition.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
GraphDefinition.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
GraphDefinition.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
GraphDefinition.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
GraphDefinition.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
GraphDefinition.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
GraphDefinition.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
GraphDefinition.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
GraphDefinition.name This element is included in summaries. C 1..1 string Name for this graph definition (computer friendly)
GraphDefinition.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
GraphDefinition.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
GraphDefinition.contact This element must be supported. This element is included in summaries. 0..* ContactDetail Contact details for the publisher
GraphDefinition.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
GraphDefinition.jurisdiction This element must be supported. This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for graph definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
GraphDefinition.purpose This element must be supported. 0..1 markdown Why this graph definition is defined
GraphDefinition.start This element is included in summaries. 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
GraphDefinition.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍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.

Constraints

Id Grade Path(s) Description Expression
dom-2 error GraphDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error GraphDefinition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error GraphDefinition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error GraphDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice GraphDefinition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
gdf-0 warning GraphDefinition Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
pub-1 error GraphDefinition If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

Differential View

This structure is derived from GraphDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: doco
GraphDefinition C 1..1 GraphDefinition Definition of a graph of resources
Constraints: pub-1
GraphDefinition.meta
GraphDefinition.meta.Slices for extension Content/Rules for all slices
GraphDefinition.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
GraphDefinition.Slices for extension Content/Rules for all slices
GraphDefinition.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
GraphDefinition.Slices for extension.extension:identifier This element must be supported. 0..* Identifier Additional identifier for the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
GraphDefinition.Slices for extension.extension:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
GraphDefinition.Slices for extension.extension:copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
GraphDefinition.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
GraphDefinition.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
GraphDefinition.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
GraphDefinition.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
GraphDefinition.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
GraphDefinition.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
GraphDefinition.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
GraphDefinition.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
GraphDefinition.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
GraphDefinition.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
GraphDefinition.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x]
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
GraphDefinition.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
GraphDefinition.date This element must be supported. 1..1 dateTime Date last changed
GraphDefinition.contact This element must be supported. 0..* ContactDetail Contact details for the publisher
GraphDefinition.useContext This element must be supported. 0..* UsageContext The context that the content is intended to support
GraphDefinition.jurisdiction This element must be supported. 0..* CodeableConcept Intended jurisdiction for graph definition (if applicable)
GraphDefinition.purpose This element must be supported. 0..1 markdown Why this graph definition is defined

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
pub-1 error GraphDefinition If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
GraphDefinition C 1..1 GraphDefinition Definition of a graph of resources
Constraints: gdf-0, pub-1
GraphDefinition.id This element is included in summaries. 0..1 id Logical id of this artifact
GraphDefinition.meta This element is included in summaries. 0..1 Meta Metadata about the resource
GraphDefinition.meta.id 0..1 string Unique id for inter-element referencing
GraphDefinition.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
GraphDefinition.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
GraphDefinition.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
GraphDefinition.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
GraphDefinition.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
GraphDefinition.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
GraphDefinition.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
GraphDefinition.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
GraphDefinition.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
GraphDefinition.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
GraphDefinition.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
GraphDefinition.contained 0..* Resource Contained, inline Resources
GraphDefinition.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
GraphDefinition.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
GraphDefinition.Slices for extension.extension:identifier This element must be supported. 0..* Identifier Additional identifier for the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
GraphDefinition.Slices for extension.extension:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
GraphDefinition.Slices for extension.extension:copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
GraphDefinition.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
GraphDefinition.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
GraphDefinition.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
GraphDefinition.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
GraphDefinition.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
GraphDefinition.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
GraphDefinition.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
GraphDefinition.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
GraphDefinition.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
GraphDefinition.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
GraphDefinition.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
GraphDefinition.Slices for extension.extension:relatedArtifact.id 0..1 string Unique id for inter-element referencing
GraphDefinition.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
GraphDefinition.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].id 0..1 string Unique id for inter-element referencing
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].label This element is included in summaries. 0..1 string Short label
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].display This element is included in summaries. 0..1 string Brief description of the related artifact
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].citation This element is included in summaries. 0..1 markdown Bibliographic citation for the artifact
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].url This element is included in summaries. 0..1 url Where the artifact can be accessed
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].document This element is included in summaries. 0..1 Attachment What document is being referenced
GraphDefinition.Slices for extension.extension:relatedArtifact.value[x].resource This element is included in summaries. 0..1 canonical(Resource) What resource is being referenced
GraphDefinition.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
GraphDefinition.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
GraphDefinition.url This element is included in summaries. 0..1 uri Canonical identifier for this graph definition, represented as a URI (globally unique)
GraphDefinition.version This element is included in summaries. 0..1 string Business version of the graph definition
GraphDefinition.name This element is included in summaries. C 1..1 string Name for this graph definition (computer friendly)
GraphDefinition.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
GraphDefinition.experimental This element is included in summaries. 0..1 boolean For testing purposes, not real usage
GraphDefinition.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
GraphDefinition.publisher This element is included in summaries. 0..1 string Name of the publisher (organization or individual)
GraphDefinition.contact This element must be supported. This element is included in summaries. 0..* ContactDetail Contact details for the publisher
GraphDefinition.description 0..1 markdown Natural language description of the graph definition
GraphDefinition.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
GraphDefinition.jurisdiction This element must be supported. This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for graph definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
GraphDefinition.purpose This element must be supported. 0..1 markdown Why this graph definition is defined
GraphDefinition.start This element is included in summaries. 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.
GraphDefinition.profile 0..1 canonical(StructureDefinition) Profile on base resource
GraphDefinition.link 0..* BackboneElement Links this graph makes rules about
GraphDefinition.link.id 0..1 string Unique id for inter-element referencing
GraphDefinition.link.extension 0..* Extension Additional content defined by implementations
GraphDefinition.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
GraphDefinition.link.path 0..1 string Path in the resource that contains the link
GraphDefinition.link.sliceName 0..1 string Which slice (if profiled)
GraphDefinition.link.min 0..1 integer Minimum occurrences for this link
GraphDefinition.link.max 0..1 string Maximum occurrences for this link
GraphDefinition.link.description 0..1 string Why this link is specified
GraphDefinition.link.target 0..* BackboneElement Potential target for the link
GraphDefinition.link.target.id 0..1 string Unique id for inter-element referencing
GraphDefinition.link.target.extension 0..* Extension Additional content defined by implementations
GraphDefinition.link.target.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
GraphDefinition.link.target.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.
GraphDefinition.link.target.params 0..1 string Criteria for reverse lookup
GraphDefinition.link.target.profile 0..1 canonical(StructureDefinition) Profile for the target resource
GraphDefinition.link.target.compartment 0..* BackboneElement Compartment Consistency Rules
GraphDefinition.link.target.compartment.id 0..1 string Unique id for inter-element referencing
GraphDefinition.link.target.compartment.extension 0..* Extension Additional content defined by implementations
GraphDefinition.link.target.compartment.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
GraphDefinition.link.target.compartment.use 1..1 code condition | requirement
Binding: GraphCompartmentUse (required): Defines how a compartment rule is used.
GraphDefinition.link.target.compartment.code 1..1 code Patient | Encounter | RelatedPerson | Practitioner | Device
Binding: CompartmentType (required): Identifies a compartment.
GraphDefinition.link.target.compartment.rule 1..1 code identical | matching | different | custom
Binding: GraphCompartmentRule (required): How a compartment must be linked.
GraphDefinition.link.target.compartment.expression 0..1 string Custom rule, as a FHIRPath expression
GraphDefinition.link.target.compartment.description 0..1 string Documentation for FHIRPath expression
GraphDefinition.link.target.link 0..* See link (GraphDefinition) Additional links from target resource

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
GraphDefinition.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
GraphDefinition.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
GraphDefinition.language Base preferred Common Languages 📍4.0.1 FHIR Std.
GraphDefinition.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍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.

Constraints

Id Grade Path(s) Description Expression
dom-2 error GraphDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error GraphDefinition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error GraphDefinition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error GraphDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice GraphDefinition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
gdf-0 warning GraphDefinition Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
pub-1 error GraphDefinition If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

 

Other representations of profile: CSV, Excel, Schematron