Shared Health Specification and Guide Version 2.0 Revision F

 

The official URL for this profile is:

http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-reference

Download Excel representation

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

>

This structure is derived from Reference

NameCard.TypeConstraints and Usage
.  Reference 0..*ref-1: SHALL have a local reference if the resource is provided inline
Definition:
A reference from one resource to another.

..  reference 1..1stringDefinition:
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.


Comments:
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

This structure is derived from Reference

Summary

Mandatory: 1 element
Must-Support: 1 element

NameFlagsCard.TypeDescription & Constraintsdoco
.. Reference SI0..*A reference from one resource to another
... id 0..1idxml:id (or equivalent in JSON)
... extension 0..*ExtensionAdditional Content defined by implementations
... reference SΣI1..1stringRelative, internal or absolute URL reference
... display Σ0..1stringText alternative for the resource

doco Documentation for this format

Grid View

This structure is derived from Reference

NameCard.TypeConstraints and Usage
.  Reference 0..*ref-1: SHALL have a local reference if the resource is provided inline
Definition:
A reference from one resource to another.

..  reference 1..1stringDefinition:
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.


Comments:
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

This structure is derived from Reference

Summary

Mandatory: 1 element
Must-Support: 1 element

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Reference SI0..*A reference from one resource to another
... id 0..1idxml:id (or equivalent in JSON)
... extension 0..*ExtensionAdditional Content defined by implementations
... reference SΣI1..1stringRelative, internal or absolute URL reference
... display Σ0..1stringText alternative for the resource

doco Documentation for this format

 

Other representations of profile: Schematron

Constraints

IdPathDetailsRequirements
ref-1ReferenceSHALL have a local reference if the resource is provided inline
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))