FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

FHIR Infrastructure icon Work GroupMaturity Level: 1 Trial UseSecurity Category: Anonymous Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the GraphDefinition resource.

GraphDefinition
Element IdGraphDefinition
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.

Short DisplayDefinition of a graph of resources
Cardinality0..*
TypeCanonicalResource
Summaryfalse
Invariants
Defined on this element
cnl-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){1,254}')
GraphDefinition.url
Element IdGraphDefinition.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 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.

Short DisplayCanonical identifier for this graph definition, represented as a URI (globally unique)
Cardinality0..1
Typeuri
Requirements

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

Summarytrue
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.

Invariants
Defined on this element
cnl-1Warning URL should not contain | or # - these characters make processing canonical references problematicurl.matches('([^|#])*')
GraphDefinition.version
Element IdGraphDefinition.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.

Short DisplayBusiness version of the graph definition
NoteThis is a business versionId, not a resource version id (see discussion)
Cardinality0..1
Typestring
Summarytrue
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]. The version SHOULD NOT contain a '#' - see Business Version.

GraphDefinition.versionAlgorithm[x]
Element IdGraphDefinition.versionAlgorithm[x]
Definition

Indicates the mechanism used to compare versions to determine which is more current.

Short DisplayHow to compare versions
Cardinality0..1
Terminology BindingVersion Algorithm (Extensible)
Typestring|Coding
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summarytrue
Comments

If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

GraphDefinition.name
Element IdGraphDefinition.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.

Short DisplayName for this graph definition (computer friendly)
Cardinality1..1
Typestring
Requirements

Support human navigation and code generation.

Summarytrue
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.

Invariants
Affect this element
cnl-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){1,254}')
GraphDefinition.title
Element IdGraphDefinition.title
Definition

A short, descriptive, user-friendly title for the capability statement.

Short DisplayName for this graph definition (human friendly)
Cardinality0..1
Typestring
Summarytrue
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

GraphDefinition.status
Element IdGraphDefinition.status
Definition

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

Short Displaydraft | active | retired | unknown
Cardinality1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)
Summarytrue
Comments

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

GraphDefinition.experimental
Element IdGraphDefinition.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.

Short DisplayFor testing purposes, not real usage
Cardinality0..1
Typeboolean
Meaning if MissingIf absent, this resource is treated as though it is not experimental.
Requirements

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

Summarytrue
Comments

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

GraphDefinition.date
Element IdGraphDefinition.date
Definition

The date (and optionally time) when the graph definition was last significantly changed. 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.

Short DisplayDate last changed
Cardinality0..1
TypedateTime
Alternate NamesRevision Date
Summarytrue
Comments

The date is often not tracked until the resource is published, but may be present on draft content. 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.

GraphDefinition.publisher
Element IdGraphDefinition.publisher
Definition

The name of the organization or individual responsible for the release and ongoing maintenance of the graph definition.

Short DisplayName of the publisher/steward (organization or individual)
Cardinality0..1
Typestring
Requirements

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

Summarytrue
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.

GraphDefinition.contact
Element IdGraphDefinition.contact
Definition

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

Short DisplayContact details for the publisher
Cardinality0..*
TypeContactDetail
Summarytrue
Comments

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

GraphDefinition.description
Element IdGraphDefinition.description
Definition

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

Short DisplayNatural language description of the graph definition
Cardinality0..1
Typemarkdown
Summaryfalse
Comments

This description can be used to capture details such as 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).

GraphDefinition.useContext
Element IdGraphDefinition.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.

Short DisplayThe context that the content is intended to support
Cardinality0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summarytrue
Comments

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

GraphDefinition.jurisdiction
Element IdGraphDefinition.jurisdiction
Definition

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

Short DisplayIntended jurisdiction for graph definition (if applicable)
Cardinality0..*
Terminology BindingJurisdiction ValueSet (Extensible)
TypeCodeableConcept
Summarytrue
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.

GraphDefinition.purpose
Element IdGraphDefinition.purpose
Definition

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

Short DisplayWhy this graph definition is defined
Cardinality0..1
Typemarkdown
Summaryfalse
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.

GraphDefinition.start
Element IdGraphDefinition.start
Definition

The Node at which instances of this graph start. If there is no nominated start, the graph can start at any of the nodes.

Short DisplayStarting Node
Cardinality0..1
Typeid
Summaryfalse
GraphDefinition.node
Element IdGraphDefinition.node
Definition

Potential target for the link.

Short DisplayPotential target for the link
Cardinality0..*
Summaryfalse
GraphDefinition.node.nodeId
Element IdGraphDefinition.node.nodeId
Definition

Internal ID of node - target for link references.

Short DisplayInternal ID - target for link references
Cardinality1..1
Typeid
Summaryfalse
GraphDefinition.node.description
Element IdGraphDefinition.node.description
Definition

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

Short DisplayWhy this node is specified
Cardinality0..1
Typestring
Summaryfalse
GraphDefinition.node.type
Element IdGraphDefinition.node.type
Definition

Type of resource this link refers to.

Short DisplayType of resource this link refers to
Cardinality1..1
Terminology BindingAll Resource Types (Required)
Typecode
Summaryfalse
GraphDefinition.node.profile
Element IdGraphDefinition.node.profile
Definition

Profile for the target resource.

Short DisplayProfile for the target resource
Cardinality0..1
Typecanonical(StructureDefinition)
Summaryfalse
GraphDefinition.link
Element IdGraphDefinition.link
Definition

Links this graph makes rules about.

Short DisplayLinks this graph makes rules about
Cardinality0..*
Summaryfalse
GraphDefinition.link.description
Element IdGraphDefinition.link.description
Definition

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

Short DisplayWhy this link is specified
Cardinality0..1
Typestring
Summaryfalse
GraphDefinition.link.min
Element IdGraphDefinition.link.min
Definition

Minimum occurrences for this link.

Short DisplayMinimum occurrences for this link
Cardinality0..1
Typeinteger
Summaryfalse
GraphDefinition.link.max
Element IdGraphDefinition.link.max
Definition

Maximum occurrences for this link.

Short DisplayMaximum occurrences for this link
Cardinality0..1
Typestring
Summaryfalse
GraphDefinition.link.sourceId
Element IdGraphDefinition.link.sourceId
Definition

The source node for this link.

Short DisplaySource Node for this link
Cardinality1..1
Typeid
Summaryfalse
GraphDefinition.link.path
Element IdGraphDefinition.link.path
Definition

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

Short DisplayPath in the resource that contains the link
Cardinality0..1
Typestring
Summaryfalse
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.

GraphDefinition.link.sliceName
Element IdGraphDefinition.link.sliceName
Definition

Which slice (if profiled).

Short DisplayWhich slice (if profiled)
Cardinality0..1
Typestring
Summaryfalse
GraphDefinition.link.targetId
Element IdGraphDefinition.link.targetId
Definition

The target node for this link.

Short DisplayTarget Node for this link
Cardinality1..1
Typeid
Summaryfalse
GraphDefinition.link.params
Element IdGraphDefinition.link.params
Definition

A set of parameters to look up.

Short DisplayCriteria for reverse lookup
Cardinality0..1
Typestring
Summaryfalse
Comments

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

GraphDefinition.link.compartment
Element IdGraphDefinition.link.compartment
Definition

Compartment Consistency Rules.

Short DisplayCompartment Consistency Rules
Cardinality0..*
Summaryfalse
GraphDefinition.link.compartment.use
Element IdGraphDefinition.link.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.

Short Displaywhere | requires
Cardinality1..1
Terminology BindingGraphCompartmentUse (Required)
Typecode
Summaryfalse
Comments

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

GraphDefinition.link.compartment.rule
Element IdGraphDefinition.link.compartment.rule
Definition

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

Short Displayidentical | matching | different | custom
Cardinality1..1
Terminology BindingGraphCompartmentRule (Required)
Typecode
Summaryfalse
GraphDefinition.link.compartment.code
Element IdGraphDefinition.link.compartment.code
Definition

Identifies the compartment.

Short DisplayPatient | Encounter | RelatedPerson | Practitioner | Device
Cardinality1..1
Terminology BindingCompartmentType (Required)
Typecode
Summaryfalse
GraphDefinition.link.compartment.expression
Element IdGraphDefinition.link.compartment.expression
Definition

Custom rule, as a FHIRPath expression.

Short DisplayCustom rule, as a FHIRPath expression
Cardinality0..1
Typestring
Summaryfalse
GraphDefinition.link.compartment.description
Element IdGraphDefinition.link.compartment.description
Definition

Documentation for FHIRPath expression.

Short DisplayDocumentation for FHIRPath expression
Cardinality0..1
Typestring
Summaryfalse