Canonical Resource Management Infrastructure Implementation Guide
2.0.0 - STU 2 International flag

Canonical Resource Management Infrastructure Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 2.0.0 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 - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 3

Definitions for the crmi-publishablegraphdefinition resource profile

Guidance on how to interpret the contents of this table can be foundhere

0. GraphDefinition
Definition

A formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set.

ShortDefinition of a graph of resources
Control10..1*
Is Modifierfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
gdf-0: 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: 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())
gdf-0: 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}'))
2. GraphDefinition.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. GraphDefinition.meta.extension:packageSource
Slice NamepackageSource
Definition

Specifies the package in which an artifact is or was included.

ShortWhat package the artifact is defined in
Control0..1
TypeExtension(Package Source) (Complex Extension)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. GraphDefinition.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. GraphDefinition.extension:knowledgeCapability
Slice NameknowledgeCapability
Definition

Defines a knowledge capability afforded by this knowledge artifact.

Shortshareable | computable | publishable | executable
Control0..*
This element is affected by the following invariants: ele-1, pub-1
TypeExtension(CQF Knowledge capability) (Extension Type: code)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
10. GraphDefinition.extension:identifier
Slice Nameidentifier
Definition

A formal identifier that is used to identify this artifact when it is represented in other formats, or referenced in a specification, model, design or an instance.

ShortAdditional identifier for the artifact
Comments

Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this artifact outside of FHIR, where it is not possible to use the logical URI.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(Artifact Identifier) (Extension Type: Identifier)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. GraphDefinition.extension:usage
Slice Nameusage
Definition

A detailed description of how the artifact is used from a clinical perspective.

ShortDescribes the clinical usage of the artifact
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Artifact Usage) (Extension Type: markdown)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
14. GraphDefinition.extension:copyright
Slice Namecopyright
Definition

A copyright statement relating to the artifact and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the artifact.

ShortUse and/or publishing restrictions
Comments

The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.

Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Artifact Copyright) (Extension Type: markdown)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
16. GraphDefinition.extension:copyrightLabel
Slice NamecopyrightLabel
Definition

A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

ShortCopyright holder and year(s)
Comments

Defines the content expected to be rendered in all representations of the artifact. The (c) symbol should NOT be included in this string. It is expected to be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Artifact Copyright Label) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
18. GraphDefinition.extension:approvalDate
Slice NameapprovalDate
Definition

The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.

ShortWhen resource approved by publisher
Comments

The date may be more recent than the approval date because of minor changes / editorial corrections.

Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Resource Approval Date) (Extension Type: date)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
20. GraphDefinition.extension:lastReviewDate
Slice NamelastReviewDate
Definition

The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.

ShortLast review date for the resource
Comments

If specified, this is usually after the approval date.

Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Resource Last Review Date) (Extension Type: date)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
22. GraphDefinition.extension:effectivePeriod
Slice NameeffectivePeriod
Definition

The period during which the resource content was or is planned to be effective.

ShortThe effective date range for the resource
Comments

The effective period for a resource determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 would be published in 2015.

Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Resource Effective Period) (Extension Type: Period)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
24. GraphDefinition.extension:topic
Slice Nametopic
Definition

Descriptive topics related to the content of the artifact. Topics provide a high-level categorization of the artifact that can be useful for filtering and searching.

ShortE.g. Education, Treatment, Assessment, etc.
Comments

This element provides a topical categorization of the artifact, as opposed to the more structured context-of-use information provided in the useContext element.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(Artifact Topic) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
26. GraphDefinition.extension:author
Slice Nameauthor
Definition

An individual or organization primarily involved in the creation and maintenance of the artifact.

ShortWho authored the artifact
Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(Artifact Author) (Extension Type: ContactDetail)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
28. GraphDefinition.extension:editor
Slice Nameeditor
Definition

An individual or organization primarily responsible for internal coherence of the artifact.

ShortWho edited the artifact
Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(Artifact Editor) (Extension Type: ContactDetail)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
30. GraphDefinition.extension:reviewer
Slice Namereviewer
Definition

An individual or organization primarily responsible for review of some aspect of the artifact.

ShortWho reviewed the artifact
Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(Artifact Reviewer) (Extension Type: ContactDetail)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
32. GraphDefinition.extension:endorser
Slice Nameendorser
Definition

An individual or organization responsible for officially endorsing the artifact for use in some setting.

ShortWho endorsed the artifact
Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(Artifact Endorser) (Extension Type: ContactDetail)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
34. GraphDefinition.extension:artifactComment
Slice NameartifactComment
Definition

A comment containing additional documentation, a review comment, usage guidance, or other relevant information from a particular user.

ShortAdditional documentation, review, or usage guidance
Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(Artifact Comment) (Complex Extension)
Is Modifierfalse
Must Supportfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
36. GraphDefinition.extension:relatedArtifact
Slice NamerelatedArtifact
Definition

Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.

ShortAdditional documentation, citations, etc.
Comments

Each related artifact is either an attachment, or a reference to another resource, but not both.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(Artifact related artifact) (Extension Type: RelatedArtifact)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
38. GraphDefinition.extension:relatedArtifact.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..0*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on GraphDefinition.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 40. GraphDefinition.extension:relatedArtifact.url
    Definition

    Source of the definition for the extension code - a logical name or a URL.

    Shortidentifies the meaning of the extension
    Comments

    The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

    Control1..1
    Typeuri
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valuehttp://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
    42. GraphDefinition.extension:relatedArtifact.value[x]
    Definition

    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

    ShortValue of extension
    Control10..1
    TypeRelatedArtifact, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    44. GraphDefinition.extension:relatedArtifact.value[x].extension:publicationDate
    Slice NamepublicationDate
    Definition

    Specifies the publication date of the referenced artifacts.

    ShortPublication date of referenced artifact
    Control0..1
    TypeExtension(CQF Publication Date) (Extension Type: date)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    46. GraphDefinition.extension:relatedArtifact.value[x].extension:publicationStatus
    Slice NamepublicationStatus
    Definition

    Specifies the publication status of the referenced artifacts.

    ShortPublication status of referenced artifact
    Control0..1
    TypeExtension(Publication Status) (Extension Type: code)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    48. GraphDefinition.extension:relatedArtifact.value[x].type
    Definition

    The type of relationship to the related artifact.

    Shortdocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
    Control1..1
    BindingThe codes SHALL be taken from RelatedArtifactTypehttp://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1
    (required to http://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1)

    The type of relationship to the related artifact.

    Typecode
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    50. GraphDefinition.extension:authoritativeSource
    Slice NameauthoritativeSource
    Definition

    A reference to the offical/source of truth definition of the content, typically outside the FHIR ecosystem. For example, the authoritativeSource for a ValueSet might be a spreadsheet published on an agency website.

    ShortOriginal definitions
    Comments

    Note that this concept is different from web-source (where the page for the content can be found it is different from the canonical), and package-source (what package the resource came from). This is an abbreviated way of saying something that could be expressed with Provenance. This extensions points to the content, not the authority for the content.

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Artifact Authoritative Source) (Extension Type: uri)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    52. GraphDefinition.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Summaryfalse
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    54. GraphDefinition.name
    Definition

    A natural language name identifying the graph definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

    ShortName for this graph definition (computer friendly)
    Comments

    The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

    Control1..1
    This element is affected by the following invariants: inv-0
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Support human navigation and code generation.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    56. GraphDefinition.status
    Definition

    The status of this graph definition. Enables tracking the life-cycle of the content.

    Shortdraft | active | retired | unknown
    Comments

    Allows filtering of graph definitions that are appropriate for use versus not.

    Control1..1
    BindingThe codes SHALL be taken from PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1
    (required to http://hl7.org/fhir/ValueSet/publication-status|4.0.1)

    The lifecycle status of an artifact.

    Typecode
    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    58. GraphDefinition.date
    Definition

    The date (and optionally time) when the graph definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the graph definition changes.

    ShortDate last changed
    Comments

    Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the graph definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

    Control10..1
    TypedateTime
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Alternate NamesRevision Date
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    60. GraphDefinition.contact
    Definition

    Contact details to assist a user in finding and communicating with the publisher.

    ShortContact details for the publisher
    Comments

    May be a web site, an email address, a telephone number, etc.

    Control0..*
    TypeContactDetail
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    62. GraphDefinition.useContext
    Definition

    The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate graph definition instances.

    ShortThe context that the content is intended to support
    Comments

    When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

    Control0..*
    TypeUsageContext
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Requirements

    Assist in searching for appropriate content.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    64. GraphDefinition.jurisdiction
    Definition

    A legal or geographic region in which the graph definition is intended to be used.

    ShortIntended jurisdiction for graph definition (if applicable)
    Comments

    It may be possible for the graph definition to be used in jurisdictions other than those for which it was originally designed or intended.

    Control0..*
    BindingUnless not suitable, these codes SHALL be taken from Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdiction|4.0.1
    (extensible to http://hl7.org/fhir/ValueSet/jurisdiction|4.0.1)

    Countries and regions within which this artifact is targeted for use.

    TypeCodeableConcept
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    66. GraphDefinition.purpose
    Definition

    Explanation of why this graph definition is needed and why it has been designed as it has.

    ShortWhy this graph definition is defined
    Comments

    This element does not describe the usage of the graph definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this graph definition.

    Control0..1
    Typemarkdown
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    68. GraphDefinition.start
    Definition

    The type of FHIR resource at which instances of this graph start.

    ShortType of resource at which the graph starts
    Control1..1
    BindingThe codes SHALL be taken from ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1
    (required to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

    One of the resource types defined as part of this version of FHIR.

    Typecode
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

    Guidance on how to interpret the contents of this table can be foundhere

    0. GraphDefinition
    Control1..1
    Invariantspub-1: 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())
    2. GraphDefinition.meta
    4. GraphDefinition.meta.extension:packageSource
    Slice NamepackageSource
    Control0..1
    TypeExtension(Package Source) (Complex Extension)
    Must Supporttrue
    6. GraphDefinition.extension:knowledgeCapability
    Slice NameknowledgeCapability
    TypeExtension(CQF Knowledge capability) (Extension Type: code)
    Must Supporttrue
    8. GraphDefinition.extension:identifier
    Slice Nameidentifier
    Control0..*
    TypeExtension(Artifact Identifier) (Extension Type: Identifier)
    Must Supporttrue
    10. GraphDefinition.extension:usage
    Slice Nameusage
    Control0..1
    TypeExtension(Artifact Usage) (Extension Type: markdown)
    Must Supporttrue
    12. GraphDefinition.extension:copyright
    Slice Namecopyright
    Control0..1
    TypeExtension(Artifact Copyright) (Extension Type: markdown)
    Must Supporttrue
    14. GraphDefinition.extension:copyrightLabel
    Slice NamecopyrightLabel
    Control0..1
    TypeExtension(Artifact Copyright Label) (Extension Type: string)
    Must Supporttrue
    16. GraphDefinition.extension:approvalDate
    Slice NameapprovalDate
    Control0..1
    TypeExtension(Resource Approval Date) (Extension Type: date)
    Must Supporttrue
    18. GraphDefinition.extension:lastReviewDate
    Slice NamelastReviewDate
    Control0..1
    TypeExtension(Resource Last Review Date) (Extension Type: date)
    Must Supporttrue
    20. GraphDefinition.extension:effectivePeriod
    Slice NameeffectivePeriod
    Control0..1
    TypeExtension(Resource Effective Period) (Extension Type: Period)
    Must Supporttrue
    22. GraphDefinition.extension:topic
    Slice Nametopic
    Control0..*
    TypeExtension(Artifact Topic) (Extension Type: CodeableConcept)
    Must Supporttrue
    24. GraphDefinition.extension:author
    Slice Nameauthor
    Control0..*
    TypeExtension(Artifact Author) (Extension Type: ContactDetail)
    Must Supporttrue
    26. GraphDefinition.extension:editor
    Slice Nameeditor
    Control0..*
    TypeExtension(Artifact Editor) (Extension Type: ContactDetail)
    Must Supporttrue
    28. GraphDefinition.extension:reviewer
    Slice Namereviewer
    Control0..*
    TypeExtension(Artifact Reviewer) (Extension Type: ContactDetail)
    Must Supporttrue
    30. GraphDefinition.extension:endorser
    Slice Nameendorser
    Control0..*
    TypeExtension(Artifact Endorser) (Extension Type: ContactDetail)
    Must Supporttrue
    32. GraphDefinition.extension:artifactComment
    Slice NameartifactComment
    Control0..*
    TypeExtension(Artifact Comment) (Complex Extension)
    Must Supportfalse
    34. GraphDefinition.extension:relatedArtifact
    Slice NamerelatedArtifact
    Control0..*
    TypeExtension(Artifact related artifact) (Extension Type: RelatedArtifact)
    Must Supporttrue
    36. GraphDefinition.extension:relatedArtifact.value[x]
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    38. GraphDefinition.extension:relatedArtifact.value[x].extension:publicationDate
    Slice NamepublicationDate
    Control0..1
    TypeExtension(CQF Publication Date) (Extension Type: date)
    40. GraphDefinition.extension:relatedArtifact.value[x].extension:publicationStatus
    Slice NamepublicationStatus
    Control0..1
    TypeExtension(Publication Status) (Extension Type: code)
    42. GraphDefinition.extension:authoritativeSource
    Slice NameauthoritativeSource
    Control0..1
    TypeExtension(Artifact Authoritative Source) (Extension Type: uri)
    Must Supporttrue
    44. GraphDefinition.date
    Control1..1
    Must Supporttrue
    46. GraphDefinition.contact
    Must Supporttrue
    48. GraphDefinition.useContext
    Must Supporttrue
    50. GraphDefinition.jurisdiction
    Must Supporttrue
    52. GraphDefinition.purpose
    Must Supporttrue

    Guidance on how to interpret the contents of this table can be foundhere

    0. GraphDefinition
    Definition

    A formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set.

    ShortDefinition of a graph of resources
    Control1..1
    Is Modifierfalse
    Summaryfalse
    Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
    dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
    dom-6: A resource should have narrative for robust management (text.`div`.exists())
    gdf-0: 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: 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())
    2. GraphDefinition.id
    Definition

    The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

    ShortLogical id of this artifact
    Comments

    The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

    Control0..1
    Typeid
    Is Modifierfalse
    Summarytrue
    4. GraphDefinition.meta
    Definition

    The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

    ShortMetadata about the resource
    Control0..1
    TypeMeta
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    6. GraphDefinition.meta.id
    Definition

    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

    ShortUnique id for inter-element referencing
    Control0..1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    8. GraphDefinition.meta.extension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    ShortAdditional content defined by implementations
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingThis element introduces a set of slices on GraphDefinition.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 10. GraphDefinition.meta.extension:packageSource
      Slice NamepackageSource
      Definition

      Specifies the package in which an artifact is or was included.

      ShortWhat package the artifact is defined in
      Control0..1
      TypeExtension(Package Source) (Complex Extension)
      Is Modifierfalse
      Must Supporttrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      12. GraphDefinition.meta.versionId
      Definition

      The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

      ShortVersion specific identifier
      Comments

      The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

      Control0..1
      Typeid
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      14. GraphDefinition.meta.lastUpdated
      Definition

      When the resource last changed - e.g. when the version changed.

      ShortWhen the resource version last changed
      Comments

      This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

      Control0..1
      Typeinstant
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      16. GraphDefinition.meta.source
      Definition

      A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

      ShortIdentifies where the resource comes from
      Comments

      In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

      This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

      Control0..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      18. GraphDefinition.meta.profile
      Definition

      A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

      ShortProfiles this resource claims to conform to
      Comments

      It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

      Control0..*
      Typecanonical(StructureDefinition)
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      20. GraphDefinition.meta.security
      Definition

      Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

      ShortSecurity Labels applied to this resource
      Comments

      The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

      Control0..*
      BindingUnless not suitable, these codes SHALL be taken from All Security Labels
      (extensible to http://hl7.org/fhir/ValueSet/security-labels|4.0.1)

      Security Labels from the Healthcare Privacy and Security Classification System.

      TypeCoding
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      22. GraphDefinition.meta.tag
      Definition

      Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

      ShortTags applied to this resource
      Comments

      The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

      Control0..*
      BindingFor example codes, see CommonTags
      (example to http://hl7.org/fhir/ValueSet/common-tags|4.0.1)

      Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

      TypeCoding
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      24. GraphDefinition.implicitRules
      Definition

      A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

      ShortA set of rules under which this content was created
      Comments

      Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

      Control0..1
      Typeuri
      Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      26. GraphDefinition.language
      Definition

      The base language in which the resource is written.

      ShortLanguage of the resource content
      Comments

      Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

      Control0..1
      BindingThe codes SHOULD be taken from CommonLanguages
      (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

      A human language.

      Additional BindingsPurpose
      AllLanguagesMax Binding
      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      28. GraphDefinition.text
      Definition

      A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

      ShortText summary of the resource, for human interpretation
      Comments

      Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

      Control0..1
      TypeNarrative
      Is Modifierfalse
      Summaryfalse
      Alternate Namesnarrative, html, xhtml, display
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      30. GraphDefinition.contained
      Definition

      These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

      ShortContained, inline Resources
      Comments

      This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

      Control0..*
      TypeResource
      Is Modifierfalse
      Summaryfalse
      Alternate Namesinline resources, anonymous resources, contained resources
      32. GraphDefinition.extension
      Definition

      An Extension

      ShortExtension
      Control0..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      SlicingThis element introduces a set of slices on GraphDefinition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 34. GraphDefinition.extension:knowledgeCapability
        Slice NameknowledgeCapability
        Definition

        Defines a knowledge capability afforded by this knowledge artifact.

        Shortshareable | computable | publishable | executable
        Control0..*
        This element is affected by the following invariants: ele-1, pub-1
        TypeExtension(CQF Knowledge capability) (Extension Type: code)
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        36. GraphDefinition.extension:identifier
        Slice Nameidentifier
        Definition

        A formal identifier that is used to identify this artifact when it is represented in other formats, or referenced in a specification, model, design or an instance.

        ShortAdditional identifier for the artifact
        Comments

        Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this artifact outside of FHIR, where it is not possible to use the logical URI.

        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(Artifact Identifier) (Extension Type: Identifier)
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        38. GraphDefinition.extension:usage
        Slice Nameusage
        Definition

        A detailed description of how the artifact is used from a clinical perspective.

        ShortDescribes the clinical usage of the artifact
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(Artifact Usage) (Extension Type: markdown)
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        40. GraphDefinition.extension:copyright
        Slice Namecopyright
        Definition

        A copyright statement relating to the artifact and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the artifact.

        ShortUse and/or publishing restrictions
        Comments

        The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.

        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(Artifact Copyright) (Extension Type: markdown)
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        42. GraphDefinition.extension:copyrightLabel
        Slice NamecopyrightLabel
        Definition

        A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

        ShortCopyright holder and year(s)
        Comments

        Defines the content expected to be rendered in all representations of the artifact. The (c) symbol should NOT be included in this string. It is expected to be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(Artifact Copyright Label) (Extension Type: string)
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        44. GraphDefinition.extension:approvalDate
        Slice NameapprovalDate
        Definition

        The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.

        ShortWhen resource approved by publisher
        Comments

        The date may be more recent than the approval date because of minor changes / editorial corrections.

        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(Resource Approval Date) (Extension Type: date)
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        46. GraphDefinition.extension:lastReviewDate
        Slice NamelastReviewDate
        Definition

        The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.

        ShortLast review date for the resource
        Comments

        If specified, this is usually after the approval date.

        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(Resource Last Review Date) (Extension Type: date)
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        48. GraphDefinition.extension:effectivePeriod
        Slice NameeffectivePeriod
        Definition

        The period during which the resource content was or is planned to be effective.

        ShortThe effective date range for the resource
        Comments

        The effective period for a resource determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 would be published in 2015.

        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(Resource Effective Period) (Extension Type: Period)
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        50. GraphDefinition.extension:topic
        Slice Nametopic
        Definition

        Descriptive topics related to the content of the artifact. Topics provide a high-level categorization of the artifact that can be useful for filtering and searching.

        ShortE.g. Education, Treatment, Assessment, etc.
        Comments

        This element provides a topical categorization of the artifact, as opposed to the more structured context-of-use information provided in the useContext element.

        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(Artifact Topic) (Extension Type: CodeableConcept)
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        52. GraphDefinition.extension:author
        Slice Nameauthor
        Definition

        An individual or organization primarily involved in the creation and maintenance of the artifact.

        ShortWho authored the artifact
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(Artifact Author) (Extension Type: ContactDetail)
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        54. GraphDefinition.extension:editor
        Slice Nameeditor
        Definition

        An individual or organization primarily responsible for internal coherence of the artifact.

        ShortWho edited the artifact
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(Artifact Editor) (Extension Type: ContactDetail)
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        56. GraphDefinition.extension:reviewer
        Slice Namereviewer
        Definition

        An individual or organization primarily responsible for review of some aspect of the artifact.

        ShortWho reviewed the artifact
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(Artifact Reviewer) (Extension Type: ContactDetail)
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        58. GraphDefinition.extension:endorser
        Slice Nameendorser
        Definition

        An individual or organization responsible for officially endorsing the artifact for use in some setting.

        ShortWho endorsed the artifact
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(Artifact Endorser) (Extension Type: ContactDetail)
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        60. GraphDefinition.extension:artifactComment
        Slice NameartifactComment
        Definition

        A comment containing additional documentation, a review comment, usage guidance, or other relevant information from a particular user.

        ShortAdditional documentation, review, or usage guidance
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(Artifact Comment) (Complex Extension)
        Is Modifierfalse
        Must Supportfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        62. GraphDefinition.extension:relatedArtifact
        Slice NamerelatedArtifact
        Definition

        Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.

        ShortAdditional documentation, citations, etc.
        Comments

        Each related artifact is either an attachment, or a reference to another resource, but not both.

        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(Artifact related artifact) (Extension Type: RelatedArtifact)
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        64. GraphDefinition.extension:relatedArtifact.id
        Definition

        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        ShortUnique id for inter-element referencing
        Control0..1
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        66. GraphDefinition.extension:relatedArtifact.extension
        Definition

        An Extension

        ShortExtension
        Control0..0
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        SlicingThis element introduces a set of slices on GraphDefinition.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 68. GraphDefinition.extension:relatedArtifact.url
          Definition

          Source of the definition for the extension code - a logical name or a URL.

          Shortidentifies the meaning of the extension
          Comments

          The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

          Control1..1
          Typeuri
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          Fixed Valuehttp://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
          70. GraphDefinition.extension:relatedArtifact.value[x]
          Definition

          Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

          ShortValue of extension
          Control1..1
          TypeRelatedArtifact
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Is Modifierfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          72. GraphDefinition.extension:relatedArtifact.value[x].id
          Definition

          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

          ShortUnique id for inter-element referencing
          Control0..1
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          74. GraphDefinition.extension:relatedArtifact.value[x].extension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          ShortAdditional content defined by implementations
          Comments

          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

          Control0..*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          SlicingThis element introduces a set of slices on GraphDefinition.extension.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 76. GraphDefinition.extension:relatedArtifact.value[x].extension:publicationDate
            Slice NamepublicationDate
            Definition

            Specifies the publication date of the referenced artifacts.

            ShortPublication date of referenced artifact
            Control0..1
            TypeExtension(CQF Publication Date) (Extension Type: date)
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            78. GraphDefinition.extension:relatedArtifact.value[x].extension:publicationStatus
            Slice NamepublicationStatus
            Definition

            Specifies the publication status of the referenced artifacts.

            ShortPublication status of referenced artifact
            Control0..1
            TypeExtension(Publication Status) (Extension Type: code)
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            80. GraphDefinition.extension:relatedArtifact.value[x].type
            Definition

            The type of relationship to the related artifact.

            Shortdocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
            Control1..1
            BindingThe codes SHALL be taken from RelatedArtifactType
            (required to http://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1)

            The type of relationship to the related artifact.

            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            82. GraphDefinition.extension:relatedArtifact.value[x].label
            Definition

            A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.

            ShortShort label
            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            84. GraphDefinition.extension:relatedArtifact.value[x].display
            Definition

            A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.

            ShortBrief description of the related artifact
            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            86. GraphDefinition.extension:relatedArtifact.value[x].citation
            Definition

            A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.

            ShortBibliographic citation for the artifact
            Comments

            Additional structured information about citations should be captured as extensions.

            Control0..1
            Typemarkdown
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            88. GraphDefinition.extension:relatedArtifact.value[x].url
            Definition

            A url for the artifact that can be followed to access the actual content.

            ShortWhere the artifact can be accessed
            Comments

            If a document or resource element is present, this element SHALL NOT be provided (use the url or reference in the Attachment or resource reference).

            Control0..1
            Typeurl
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            90. GraphDefinition.extension:relatedArtifact.value[x].document
            Definition

            The document being referenced, represented as an attachment. This is exclusive with the resource element.

            ShortWhat document is being referenced
            Control0..1
            TypeAttachment
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            92. GraphDefinition.extension:relatedArtifact.value[x].resource
            Definition

            The related resource, such as a library, value set, profile, or other knowledge resource.

            ShortWhat resource is being referenced
            Comments

            If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource.

            Control0..1
            Typecanonical(Resource)
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            94. GraphDefinition.extension:authoritativeSource
            Slice NameauthoritativeSource
            Definition

            A reference to the offical/source of truth definition of the content, typically outside the FHIR ecosystem. For example, the authoritativeSource for a ValueSet might be a spreadsheet published on an agency website.

            ShortOriginal definitions
            Comments

            Note that this concept is different from web-source (where the page for the content can be found it is different from the canonical), and package-source (what package the resource came from). This is an abbreviated way of saying something that could be expressed with Provenance. This extensions points to the content, not the authority for the content.

            Control0..1
            This element is affected by the following invariants: ele-1
            TypeExtension(Artifact Authoritative Source) (Extension Type: uri)
            Is Modifierfalse
            Must Supporttrue
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            96. GraphDefinition.modifierExtension
            Definition

            May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

            ShortExtensions that cannot be ignored
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..*
            TypeExtension
            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
            Summaryfalse
            Requirements

            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            98. GraphDefinition.url
            Definition

            An absolute URI that is used to identify this graph definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this graph definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the graph definition is stored on different servers.

            ShortCanonical identifier for this graph definition, represented as a URI (globally unique)
            Comments

            Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

            The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

            In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

            Control0..1
            Typeuri
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            Allows the graph definition to be referenced by a single globally unique identifier.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            100. GraphDefinition.version
            Definition

            The identifier that is used to identify this version of the graph definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the graph definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

            ShortBusiness version of the graph definition
            Comments

            There may be different graph definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the graph definition with the format [url]|[version].

            NoteThis is a business version Id, not a resource version Id (see discussion)
            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            102. GraphDefinition.name
            Definition

            A natural language name identifying the graph definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

            ShortName for this graph definition (computer friendly)
            Comments

            The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

            Control1..1
            This element is affected by the following invariants: inv-0
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            Support human navigation and code generation.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            104. GraphDefinition.status
            Definition

            The status of this graph definition. Enables tracking the life-cycle of the content.

            Shortdraft | active | retired | unknown
            Comments

            Allows filtering of graph definitions that are appropriate for use versus not.

            Control1..1
            BindingThe codes SHALL be taken from PublicationStatus
            (required to http://hl7.org/fhir/ValueSet/publication-status|4.0.1)

            The lifecycle status of an artifact.

            Typecode
            Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            106. GraphDefinition.experimental
            Definition

            A Boolean value to indicate that this graph definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

            ShortFor testing purposes, not real usage
            Comments

            Allows filtering of graph definitions that are appropriate for use versus not.

            Control0..1
            Typeboolean
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            Enables experimental content to be developed following the same lifecycle that would be used for a production-level graph definition.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            108. GraphDefinition.date
            Definition

            The date (and optionally time) when the graph definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the graph definition changes.

            ShortDate last changed
            Comments

            Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the graph definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

            Control1..1
            TypedateTime
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            Alternate NamesRevision Date
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            110. GraphDefinition.publisher
            Definition

            The name of the organization or individual that published the graph definition.

            ShortName of the publisher (organization or individual)
            Comments

            Usually an organization but may be an individual. The publisher (or steward) of the graph definition is the organization or individual primarily responsible for the maintenance and upkeep of the graph definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the graph definition. This item SHOULD be populated unless the information is available from context.

            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            Helps establish the "authority/credibility" of the graph definition. May also allow for contact.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            112. GraphDefinition.contact
            Definition

            Contact details to assist a user in finding and communicating with the publisher.

            ShortContact details for the publisher
            Comments

            May be a web site, an email address, a telephone number, etc.

            Control0..*
            TypeContactDetail
            Is Modifierfalse
            Must Supporttrue
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            114. GraphDefinition.description
            Definition

            A free text natural language description of the graph definition from a consumer's perspective.

            ShortNatural language description of the graph definition
            Comments

            This description can be used to capture details such as why the graph definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the graph definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the graph definition is presumed to be the predominant language in the place the graph definition was created).

            Control0..1
            Typemarkdown
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            116. GraphDefinition.useContext
            Definition

            The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate graph definition instances.

            ShortThe context that the content is intended to support
            Comments

            When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

            Control0..*
            TypeUsageContext
            Is Modifierfalse
            Must Supporttrue
            Summarytrue
            Requirements

            Assist in searching for appropriate content.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            118. GraphDefinition.jurisdiction
            Definition

            A legal or geographic region in which the graph definition is intended to be used.

            ShortIntended jurisdiction for graph definition (if applicable)
            Comments

            It may be possible for the graph definition to be used in jurisdictions other than those for which it was originally designed or intended.

            Control0..*
            BindingUnless not suitable, these codes SHALL be taken from Jurisdiction ValueSet
            (extensible to http://hl7.org/fhir/ValueSet/jurisdiction|4.0.1)

            Countries and regions within which this artifact is targeted for use.

            TypeCodeableConcept
            Is Modifierfalse
            Must Supporttrue
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            120. GraphDefinition.purpose
            Definition

            Explanation of why this graph definition is needed and why it has been designed as it has.

            ShortWhy this graph definition is defined
            Comments

            This element does not describe the usage of the graph definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this graph definition.

            Control0..1
            Typemarkdown
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            122. GraphDefinition.start
            Definition

            The type of FHIR resource at which instances of this graph start.

            ShortType of resource at which the graph starts
            Control1..1
            BindingThe codes SHALL be taken from ResourceType
            (required to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

            One of the resource types defined as part of this version of FHIR.

            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            124. GraphDefinition.profile
            Definition

            The profile that describes the use of the base resource.

            ShortProfile on base resource
            Comments

            The code does not include the '$' prefix that is always included in the URL when the operation is invoked.

            Control0..1
            Typecanonical(StructureDefinition)
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            126. GraphDefinition.link
            Definition

            Links this graph makes rules about.

            ShortLinks this graph makes rules about
            Control0..*
            TypeBackboneElement
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            128. GraphDefinition.link.id
            Definition

            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

            ShortUnique id for inter-element referencing
            Control0..1
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            130. GraphDefinition.link.extension
            Definition

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            ShortAdditional content defined by implementations
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            132. GraphDefinition.link.modifierExtension
            Definition

            May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

            ShortExtensions that cannot be ignored even if unrecognized
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..*
            TypeExtension
            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
            Summarytrue
            Requirements

            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

            Alternate Namesextensions, user content, modifiers
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            134. GraphDefinition.link.path
            Definition

            A FHIR expression that identifies one of FHIR References to other resources.

            ShortPath in the resource that contains the link
            Comments

            The path expression cannot contain a resolve() function. If there is no path, the link is a reverse lookup, using target.params. If the path is "*" then this means all references in the resource.

            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            136. GraphDefinition.link.sliceName
            Definition

            Which slice (if profiled).

            ShortWhich slice (if profiled)
            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            138. GraphDefinition.link.min
            Definition

            Minimum occurrences for this link.

            ShortMinimum occurrences for this link
            Control0..1
            Typeinteger
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            140. GraphDefinition.link.max
            Definition

            Maximum occurrences for this link.

            ShortMaximum occurrences for this link
            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            142. GraphDefinition.link.description
            Definition

            Information about why this link is of interest in this graph definition.

            ShortWhy this link is specified
            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            144. GraphDefinition.link.target
            Definition

            Potential target for the link.

            ShortPotential target for the link
            Control0..*
            TypeBackboneElement
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            146. GraphDefinition.link.target.id
            Definition

            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

            ShortUnique id for inter-element referencing
            Control0..1
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            148. GraphDefinition.link.target.extension
            Definition

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            ShortAdditional content defined by implementations
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            150. GraphDefinition.link.target.modifierExtension
            Definition

            May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

            ShortExtensions that cannot be ignored even if unrecognized
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..*
            TypeExtension
            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
            Summarytrue
            Requirements

            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

            Alternate Namesextensions, user content, modifiers
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            152. GraphDefinition.link.target.type
            Definition

            Type of resource this link refers to.

            ShortType of resource this link refers to
            Control1..1
            BindingThe codes SHALL be taken from ResourceType
            (required to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

            One of the resource types defined as part of this version of FHIR.

            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            154. GraphDefinition.link.target.params
            Definition

            A set of parameters to look up.

            ShortCriteria for reverse lookup
            Comments

            At least one of the parameters must have the value {ref} which identifies the focus resource.

            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            156. GraphDefinition.link.target.profile
            Definition

            Profile for the target resource.

            ShortProfile for the target resource
            Control0..1
            Typecanonical(StructureDefinition)
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            158. GraphDefinition.link.target.compartment
            Definition

            Compartment Consistency Rules.

            ShortCompartment Consistency Rules
            Control0..*
            TypeBackboneElement
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            160. GraphDefinition.link.target.compartment.id
            Definition

            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

            ShortUnique id for inter-element referencing
            Control0..1
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            162. GraphDefinition.link.target.compartment.extension
            Definition

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            ShortAdditional content defined by implementations
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            164. GraphDefinition.link.target.compartment.modifierExtension
            Definition

            May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

            ShortExtensions that cannot be ignored even if unrecognized
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..*
            TypeExtension
            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
            Summarytrue
            Requirements

            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

            Alternate Namesextensions, user content, modifiers
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            166. GraphDefinition.link.target.compartment.use
            Definition

            Defines how the compartment rule is used - whether it it is used to test whether resources are subject to the rule, or whether it is a rule that must be followed.

            Shortcondition | requirement
            Comments

            All conditional rules are evaluated; if they are true, then the rules are evaluated.

            Control1..1
            BindingThe codes SHALL be taken from GraphCompartmentUse
            (required to http://hl7.org/fhir/ValueSet/graph-compartment-use|4.0.1)

            Defines how a compartment rule is used.

            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            168. GraphDefinition.link.target.compartment.code
            Definition

            Identifies the compartment.

            ShortPatient | Encounter | RelatedPerson | Practitioner | Device
            Control1..1
            BindingThe codes SHALL be taken from CompartmentType
            (required to http://hl7.org/fhir/ValueSet/compartment-type|4.0.1)

            Identifies a compartment.

            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            170. GraphDefinition.link.target.compartment.rule
            Definition

            identical | matching | different | no-rule | custom.

            Shortidentical | matching | different | custom
            Control1..1
            BindingThe codes SHALL be taken from GraphCompartmentRule
            (required to http://hl7.org/fhir/ValueSet/graph-compartment-rule|4.0.1)

            How a compartment must be linked.

            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            172. GraphDefinition.link.target.compartment.expression
            Definition

            Custom rule, as a FHIRPath expression.

            ShortCustom rule, as a FHIRPath expression
            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            174. GraphDefinition.link.target.compartment.description
            Definition

            Documentation for FHIRPath expression.

            ShortDocumentation for FHIRPath expression
            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            176. GraphDefinition.link.target.link
            Definition

            Additional links from target resource.

            ShortAdditional links from target resource
            Control0..*
            TypeSeettp://hl7.org/fhir/StructureDefinition/GraphDefinition#GraphDefinition.link
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))