Patient Care Coordination (PCC) Implementation Guide
0.1.1-current - ci-build United Kingdom flag

Patient Care Coordination (PCC) Implementation Guide - Local Development build (v0.1.1-current) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Data Type Profile: Reference - RESTful

Official URL: https://fhir.virtually.healthcare/StructureDefinition/reference-rest Version: 0.1.1-current
Draft as of 2025-11-05 Computable Name: ReferenceRest

A Reference data type where the referenced resource is expected to be resolvable RESTfully.

Usages:

  • This DataType Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Reference C 0..* Reference A reference from one resource to another
Constraints: ref-1
... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
... display SΣ 0..1 string Text alternative for the resource

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ref-1 error Reference SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from Reference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Reference 0..* Reference A reference from one resource to another
... reference S 1..1 string Literal reference, Relative, internal or absolute URL
... display S 0..1 string Text alternative for the resource

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Reference C 0..* Reference A reference from one resource to another
Constraints: ref-1
... id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
... display SΣ 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Reference.type Base extensible ResourceType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ref-1 error Reference SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from Reference

Summary

Mandatory: 1 element
Must-Support: 2 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Reference C 0..* Reference A reference from one resource to another
Constraints: ref-1
... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
... display SΣ 0..1 string Text alternative for the resource

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ref-1 error Reference SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Differential View

This structure is derived from Reference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Reference 0..* Reference A reference from one resource to another
... reference S 1..1 string Literal reference, Relative, internal or absolute URL
... display S 0..1 string Text alternative for the resource

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Reference C 0..* Reference A reference from one resource to another
Constraints: ref-1
... id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
... display SΣ 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Reference.type Base extensible ResourceType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ref-1 error Reference SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from Reference

Summary

Mandatory: 1 element
Must-Support: 2 elements

 

Other representations of profile: CSV, Excel, Schematron