This page is part of the FHIR Specification (v5.0.0-draft-final: Final QA Preview for R5 - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3
FHIR Infrastructure Work Group | Maturity Level: 1 | Trial Use | Security Category: Anonymous | Compartments: Not linked to any defined compartments |
Detailed Descriptions for the elements in the GraphDefinition resource.
GraphDefinition | |||||||||
Element Id | 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. | ||||||||
Short Display | Definition of a graph of resources | ||||||||
Cardinality | 0..* | ||||||||
Type | CanonicalResource | ||||||||
Summary | false | ||||||||
Invariants |
| ||||||||
GraphDefinition.url | |||||||||
Element Id | 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 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 Display | Canonical identifier for this graph definition, represented as a URI (globally unique) | ||||||||
Cardinality | 0..1 | ||||||||
Type | uri | ||||||||
Requirements | Allows the graph definition to be referenced by a single globally unique identifier. | ||||||||
Summary | true | ||||||||
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 |
| ||||||||
GraphDefinition.identifier | |||||||||
Element Id | GraphDefinition.identifier | ||||||||
Definition | A formal identifier that is used to identify this GraphDefinition when it is represented in other formats, or referenced in a specification, model, design or an instance. | ||||||||
Short Display | Additional identifier for the GraphDefinition (business identifier) | ||||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
Cardinality | 0..* | ||||||||
Type | Identifier | ||||||||
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. | ||||||||
Summary | true | ||||||||
GraphDefinition.version | |||||||||
Element Id | 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. | ||||||||
Short Display | Business version of the graph definition | ||||||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | true | ||||||||
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 Id | GraphDefinition.versionAlgorithm[x] | ||||||||
Definition | Indicates the mechanism used to compare versions to determine which is more current. | ||||||||
Short Display | How to compare versions | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | Version Algorithm (Extensible) | ||||||||
Type | string|Coding | ||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||
Summary | true | ||||||||
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 Id | 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. | ||||||||
Short Display | Name for this graph definition (computer friendly) | ||||||||
Cardinality | 1..1 | ||||||||
Type | string | ||||||||
Requirements | Support human navigation and code generation. | ||||||||
Summary | true | ||||||||
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 |
| ||||||||
GraphDefinition.title | |||||||||
Element Id | GraphDefinition.title | ||||||||
Definition | A short, descriptive, user-friendly title for the capability statement. | ||||||||
Short Display | Name for this graph definition (human friendly) | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | true | ||||||||
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. | ||||||||
GraphDefinition.status | |||||||||
Element Id | GraphDefinition.status | ||||||||
Definition | The status of this graph definition. Enables tracking the life-cycle of the content. | ||||||||
Short Display | draft | active | retired | unknown | ||||||||
Cardinality | 1..1 | ||||||||
Terminology Binding | PublicationStatus (Required) | ||||||||
Type | code | ||||||||
Is Modifier | true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration) | ||||||||
Summary | true | ||||||||
Comments | Allows filtering of graph definitions that are appropriate for use versus not. | ||||||||
GraphDefinition.experimental | |||||||||
Element Id | 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. | ||||||||
Short Display | For testing purposes, not real usage | ||||||||
Cardinality | 0..1 | ||||||||
Type | boolean | ||||||||
Meaning if Missing | If 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. | ||||||||
Summary | true | ||||||||
Comments | Allows filtering of graph definitions that are appropriate for use versus not. | ||||||||
GraphDefinition.date | |||||||||
Element Id | GraphDefinition.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 Display | Date last changed | ||||||||
Cardinality | 0..1 | ||||||||
Type | dateTime | ||||||||
Alternate Names | Revision Date | ||||||||
Summary | true | ||||||||
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 Id | GraphDefinition.publisher | ||||||||
Definition | The name of the organization or individual responsible for the release and ongoing maintenance of the graph definition. | ||||||||
Short Display | Name of the publisher/steward (organization or individual) | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Requirements | Helps establish the "authority/credibility" of the graph definition. May also allow for contact. | ||||||||
Summary | true | ||||||||
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 Id | GraphDefinition.contact | ||||||||
Definition | Contact details to assist a user in finding and communicating with the publisher. | ||||||||
Short Display | Contact details for the publisher | ||||||||
Cardinality | 0..* | ||||||||
Type | ContactDetail | ||||||||
Summary | true | ||||||||
Comments | May be a web site, an email address, a telephone number, etc. | ||||||||
GraphDefinition.description | |||||||||
Element Id | GraphDefinition.description | ||||||||
Definition | A free text natural language description of the graph definition from a consumer's perspective. | ||||||||
Short Display | Natural language description of the graph definition | ||||||||
Cardinality | 0..1 | ||||||||
Type | markdown | ||||||||
Summary | false | ||||||||
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 Id | 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. | ||||||||
Short Display | The context that the content is intended to support | ||||||||
Cardinality | 0..* | ||||||||
Type | UsageContext | ||||||||
Requirements | Assist in searching for appropriate content. | ||||||||
Summary | true | ||||||||
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. | ||||||||
GraphDefinition.jurisdiction | |||||||||
Element Id | GraphDefinition.jurisdiction | ||||||||
Definition | A legal or geographic region in which the graph definition is intended to be used. | ||||||||
Short Display | Intended jurisdiction for graph definition (if applicable) | ||||||||
Cardinality | 0..* | ||||||||
Terminology Binding | Jurisdiction ValueSet (Extensible) | ||||||||
Type | CodeableConcept | ||||||||
Summary | true | ||||||||
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 Id | GraphDefinition.purpose | ||||||||
Definition | Explanation of why this graph definition is needed and why it has been designed as it has. | ||||||||
Short Display | Why this graph definition is defined | ||||||||
Cardinality | 0..1 | ||||||||
Type | markdown | ||||||||
Summary | false | ||||||||
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.copyright | |||||||||
Element Id | GraphDefinition.copyright | ||||||||
Definition | A copyright statement relating to the graph definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the graph definition. | ||||||||
Short Display | Use and/or publishing restrictions | ||||||||
Cardinality | 0..1 | ||||||||
Type | markdown | ||||||||
Requirements | Consumers must be able to determine any legal restrictions on the use of the graph definition. | ||||||||
Alternate Names | License; Restrictions | ||||||||
Summary | false | ||||||||
Comments | ... | ||||||||
GraphDefinition.copyrightLabel | |||||||||
Element Id | GraphDefinition.copyrightLabel | ||||||||
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'). | ||||||||
Short Display | Copyright holder and year(s) | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Requirements | Defines the content expected to be rendered in all representations of the artifact. | ||||||||
Summary | false | ||||||||
Comments | The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element. | ||||||||
GraphDefinition.start | |||||||||
Element Id | GraphDefinition.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 Display | Starting Node | ||||||||
Cardinality | 0..1 | ||||||||
Type | id | ||||||||
Summary | false | ||||||||
GraphDefinition.node | |||||||||
Element Id | GraphDefinition.node | ||||||||
Definition | Potential target for the link. | ||||||||
Short Display | Potential target for the link | ||||||||
Cardinality | 0..* | ||||||||
Summary | false | ||||||||
GraphDefinition.node.nodeId | |||||||||
Element Id | GraphDefinition.node.nodeId | ||||||||
Definition | Internal ID of node - target for link references. | ||||||||
Short Display | Internal ID - target for link references | ||||||||
Cardinality | 1..1 | ||||||||
Type | id | ||||||||
Summary | false | ||||||||
GraphDefinition.node.description | |||||||||
Element Id | GraphDefinition.node.description | ||||||||
Definition | Information about why this node is of interest in this graph definition. | ||||||||
Short Display | Why this node is specified | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
GraphDefinition.node.type | |||||||||
Element Id | GraphDefinition.node.type | ||||||||
Definition | Type of resource this link refers to. | ||||||||
Short Display | Type of resource this link refers to | ||||||||
Cardinality | 1..1 | ||||||||
Terminology Binding | Version Independent Resource Types (All) (Required)
| ||||||||
Type | code | ||||||||
Summary | false | ||||||||
GraphDefinition.node.profile | |||||||||
Element Id | GraphDefinition.node.profile | ||||||||
Definition | Profile for the target resource. | ||||||||
Short Display | Profile for the target resource | ||||||||
Cardinality | 0..1 | ||||||||
Type | canonical(StructureDefinition) | ||||||||
Summary | false | ||||||||
GraphDefinition.link | |||||||||
Element Id | GraphDefinition.link | ||||||||
Definition | Links this graph makes rules about. | ||||||||
Short Display | Links this graph makes rules about | ||||||||
Cardinality | 0..* | ||||||||
Summary | false | ||||||||
GraphDefinition.link.description | |||||||||
Element Id | GraphDefinition.link.description | ||||||||
Definition | Information about why this link is of interest in this graph definition. | ||||||||
Short Display | Why this link is specified | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
GraphDefinition.link.min | |||||||||
Element Id | GraphDefinition.link.min | ||||||||
Definition | Minimum occurrences for this link. | ||||||||
Short Display | Minimum occurrences for this link | ||||||||
Cardinality | 0..1 | ||||||||
Type | integer | ||||||||
Summary | false | ||||||||
GraphDefinition.link.max | |||||||||
Element Id | GraphDefinition.link.max | ||||||||
Definition | Maximum occurrences for this link. | ||||||||
Short Display | Maximum occurrences for this link | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
GraphDefinition.link.sourceId | |||||||||
Element Id | GraphDefinition.link.sourceId | ||||||||
Definition | The source node for this link. | ||||||||
Short Display | Source Node for this link | ||||||||
Cardinality | 1..1 | ||||||||
Type | id | ||||||||
Summary | false | ||||||||
GraphDefinition.link.path | |||||||||
Element Id | GraphDefinition.link.path | ||||||||
Definition | A FHIRPath expression that identifies one of FHIR References to other resources. | ||||||||
Short Display | Path in the resource that contains the link | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
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 Id | GraphDefinition.link.sliceName | ||||||||
Definition | Which slice (if profiled). | ||||||||
Short Display | Which slice (if profiled) | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
GraphDefinition.link.targetId | |||||||||
Element Id | GraphDefinition.link.targetId | ||||||||
Definition | The target node for this link. | ||||||||
Short Display | Target Node for this link | ||||||||
Cardinality | 1..1 | ||||||||
Type | id | ||||||||
Summary | false | ||||||||
GraphDefinition.link.params | |||||||||
Element Id | GraphDefinition.link.params | ||||||||
Definition | A set of parameters to look up. | ||||||||
Short Display | Criteria for reverse lookup | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
Comments | At least one of the parameters must have the value {ref} which identifies the focus resource. | ||||||||
GraphDefinition.link.compartment | |||||||||
Element Id | GraphDefinition.link.compartment | ||||||||
Definition | Compartment Consistency Rules. | ||||||||
Short Display | Compartment Consistency Rules | ||||||||
Cardinality | 0..* | ||||||||
Summary | false | ||||||||
GraphDefinition.link.compartment.use | |||||||||
Element Id | GraphDefinition.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 Display | where | requires | ||||||||
Cardinality | 1..1 | ||||||||
Terminology Binding | Graph Compartment Use (Required) | ||||||||
Type | code | ||||||||
Summary | false | ||||||||
Comments | All conditional rules are evaluated; if they are true, then the rules are evaluated. | ||||||||
GraphDefinition.link.compartment.rule | |||||||||
Element Id | GraphDefinition.link.compartment.rule | ||||||||
Definition | identical | matching | different | no-rule | custom. | ||||||||
Short Display | identical | matching | different | custom | ||||||||
Cardinality | 1..1 | ||||||||
Terminology Binding | Graph Compartment Rule (Required) | ||||||||
Type | code | ||||||||
Summary | false | ||||||||
GraphDefinition.link.compartment.code | |||||||||
Element Id | GraphDefinition.link.compartment.code | ||||||||
Definition | Identifies the compartment. | ||||||||
Short Display | Patient | Encounter | RelatedPerson | Practitioner | Device | EpisodeOfCare | ||||||||
Cardinality | 1..1 | ||||||||
Terminology Binding | Compartment Type (Required) | ||||||||
Type | code | ||||||||
Summary | false | ||||||||
GraphDefinition.link.compartment.expression | |||||||||
Element Id | GraphDefinition.link.compartment.expression | ||||||||
Definition | Custom rule, as a FHIRPath expression. | ||||||||
Short Display | Custom rule, as a FHIRPath expression | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
GraphDefinition.link.compartment.description | |||||||||
Element Id | GraphDefinition.link.compartment.description | ||||||||
Definition | Documentation for FHIRPath expression. | ||||||||
Short Display | Documentation for FHIRPath expression | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false |