GraphDefinition

ResourceFoundation · ConformanceTrial useMaturity 1

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.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

12 of 14 parameters tested

Structure

Show inherited elements (17)

Element	Card.	Type	Description
urlΣ	0..1	uri	Canonical identifier for this graph definition, represented as a URI (globally unique)
versionΣ	0..1	string	Business version of the graph definition
nameRequiredΣ	1..1	string	Name for this graph definition (computer friendly)
statusRequired?!Σ	1..1	code	draft | active | retired | unknownBinding (required): publication-status
experimentalΣ	0..1	boolean	For testing purposes, not real usage
dateΣ	0..1	dateTime	Date last changed
publisherΣ	0..1	string	Name of the publisher (organization or individual)
contactΣ	0..*	ContactDetail	Contact details for the publisher
description	0..1	markdown	Natural language description of the graph definition
useContextΣ	0..*	UsageContext	The context that the content is intended to support
jurisdictionΣ	0..*	CodeableConcept	Intended jurisdiction for graph definition (if applicable)Binding (extensible): jurisdiction
purpose	0..1	markdown	Why this graph definition is defined
startRequiredΣ	1..1	code	Type of resource at which the graph startsBinding (required): resource-types
profile	0..1	canonical(StructureDefinition)	Profile on base resource
link	0..*	BackboneElement	Links this graph makes rules about
path	0..1	string	Path in the resource that contains the link
sliceName	0..1	string	Which slice (if profiled)
min	0..1	integer	Minimum occurrences for this link
max	0..1	string	Maximum occurrences for this link
description	0..1	string	Why this link is specified
target	0..*	BackboneElement	Potential target for the link
typeRequired	1..1	code	Type of resource this link refers toBinding (required): resource-types
params	0..1	string	Criteria for reverse lookup
profile	0..1	canonical(StructureDefinition)	Profile for the target resource
compartment	0..*	BackboneElement	Compartment Consistency Rules
useRequired	1..1	code	condition | requirementBinding (required): graph-compartment-use
codeRequired	1..1	code	Patient | Encounter | RelatedPerson | Practitioner | DeviceBinding (required): compartment-type
ruleRequired	1..1	code	identical | matching | different | customBinding (required): graph-compartment-rule
expression	0..1	string	Custom rule, as a FHIRPath expression
description	0..1	string	Documentation for FHIRPath expression
link	0..*	Same as GraphDefinition.link	Additional links from target resource

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/GraphDefinition?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
context	token	A use context assigned to the graph definition (GraphDefinition.useContext.value.ofType(CodeableConcept))
context-quantity	quantity	A quantity- or range-valued use context assigned to the graph definition (GraphDefinition.useContext.value.ofType(Quantity)) | (GraphDefinition.useContext.value.ofType(Range))
context-type	token	A type of use context assigned to the graph definition GraphDefinition.useContext.code
context-type-quantity	composite	A use context type and quantity- or range-based value assigned to the graph definition GraphDefinition.useContext
context-type-value	composite	A use context type and value assigned to the graph definition GraphDefinition.useContext
date	date	The graph definition publication date GraphDefinition.date
description	string	The description of the graph definition GraphDefinition.description
jurisdiction	token	Intended jurisdiction for the graph definition GraphDefinition.jurisdiction
name	string	Computationally friendly name of the graph definition GraphDefinition.name
publisher	string	Name of the publisher of the graph definition GraphDefinition.publisher
start	token	Type of resource at which the graph starts GraphDefinition.start
status	token	The current status of the graph definition GraphDefinition.status
url	uri	The uri that identifies the graph definition GraphDefinition.url
version	token	The business version of the graph definition GraphDefinition.version

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition