FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). 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 GroupMaturity Level: 0 DraftCompartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the GraphDefinition resource.

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.

Control1..1
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. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this graph definition is (or will be) published. The URL SHOULD include the major version of the graph definition. For more information see Technical and Business Versions.

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

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.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..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 refrence to a particular business version of the graph definition with the format [url]|[version].

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.

Control1..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 alpha-numeric type name to ensure that it is computable friendly.

GraphDefinition.status
Definition

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

Control1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue
Summarytrue
Comments

Allows filtering of graph definitions that are appropriate for use vs. not.
This is labeled as "Is Modifier" because applications should not use a retired graph definition without due consideration.

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.

Control0..1
Typeboolean
Is Modifiertrue
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 definition that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental graph definition in production.

GraphDefinition.date
Definition

The date (and optionally time) when the graph definition was published. The date must change if and 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.

Control0..1
TypedateTime
Alternate NamesRevision Date
Summarytrue
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.

GraphDefinition.publisher
Definition

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

Control0..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
Definition

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

Control0..*
TypeContactDetail
Summarytrue
Comments

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

GraphDefinition.description
Definition

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

Control0..1
Typemarkdown
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 profile is presumed to be the predominant language in the place the profile was created).

GraphDefinition.useContext
Definition

The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate graph definition instances.

Control0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summarytrue
Comments

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

GraphDefinition.jurisdiction
Definition

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

Control0..*
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
Definition

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

Control0..1
Typemarkdown
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
Definition

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

Control1..1
Terminology BindingAny defined Resource Type name
Typecode
GraphDefinition.profile
Definition

The profile that describes the use of the base resource.

Control0..1
Typeuri
Comments

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

GraphDefinition.link
Definition

Links this graph makes rules about.

Control0..*
GraphDefinition.link.path
Definition

Path in the resource that contains the link.

Control1..1
Typestring
Comments

The path can be a literal path (e.g. Observation.subject), or it can be a query for reverse links (e.g. Provenance?target=[id]).

GraphDefinition.link.sliceName
Definition

Which slice (if profiled).

Control0..1
Typestring
GraphDefinition.link.min
Definition

Minimum occurrences for this link.

Control0..1
Typeinteger
GraphDefinition.link.max
Definition

Maximum occurrences for this link.

Control0..1
Typestring
GraphDefinition.link.description
Definition

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

Control0..1
Typestring
GraphDefinition.link.target
Definition

Potential target for the link.

Control1..*
GraphDefinition.link.target.type
Definition

Type of resource this link refers to.

Control1..1
Terminology BindingAny defined Resource Type name
Typecode
GraphDefinition.link.target.profile
Definition

Profile for the target resource.

Control0..1
Typeuri
GraphDefinition.link.target.compartment
Definition

Compartment Consistency Rules.

Control0..*
GraphDefinition.link.target.compartment.code
Definition

Identifies the compartment.

Control1..1
Terminology BindingCompartmentType (Required)
Typecode
GraphDefinition.link.target.compartment.rule
Definition

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

Control1..1
Terminology BindingGraphCompartmentRule (Required)
Typecode
GraphDefinition.link.target.compartment.expression
Definition

Custom rule, as a FHIRPath expression.

Control0..1
Typestring
GraphDefinition.link.target.compartment.description
Definition

Documentation for FHIRPath expression.

Control0..1
Typestring
GraphDefinition.link.target.link
Definition

Additional links from target resource.

Control0..*
TypeSee GraphDefinition.link