North West Genomic Medicine Service Alliance
0.0.1 - ci-build United Kingdom flag

DRAFT Implementation Guide

This is for collaboration and discussion purposes and is subject to change.

North West Genomic Medicine Service Alliance - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Data Type Profile: CodeableReference

Official URL: https://nw-gmsa.github.io/StructureDefinition/CodeableReference Version: 0.0.1
Draft as of 2025-06-19 Computable Name: CodeableReference

Backport of FHIR R5 CodeableReference. (copied from BE eHealth Platform Federal Core Profiles). Extension able to hold a reference and a concept (Temporary solution until https://jira.hl7.org/browse/FHIR-44661 is solved and see Zulip: https://chat.fhir.org/#narrow/stream/179280-fhir.2Finfrastructure-wg/topic/Backporting.20CodeableReference)

Usages:

Formal Views of Profile Content

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

This structure is derived from Reference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Reference 0..* Reference A reference from one resource to another
... Slices for extension Content/Rules for all slices
.... extension:concept 0..1 CodeableConcept ExtCodeableReference
URL: https://nw-gmsa.github.io/StructureDefinition/ext-codeable-reference

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Reference C 0..* Reference A reference from one resource to another
Constraints: ref-1
... Slices for extension Content/Rules for all slices
.... extension:concept 0..1 CodeableConcept ExtCodeableReference
URL: https://nw-gmsa.github.io/StructureDefinition/ext-codeable-reference

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ref-1errorReferenceSHALL 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'))
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
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:concept 0..1 CodeableConcept ExtCodeableReference
URL: https://nw-gmsa.github.io/StructureDefinition/ext-codeable-reference
... reference ΣC 0..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 Σ 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Reference.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ref-1errorReferenceSHALL 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

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from Reference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Reference 0..* Reference A reference from one resource to another
... Slices for extension Content/Rules for all slices
.... extension:concept 0..1 CodeableConcept ExtCodeableReference
URL: https://nw-gmsa.github.io/StructureDefinition/ext-codeable-reference

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Reference C 0..* Reference A reference from one resource to another
Constraints: ref-1
... Slices for extension Content/Rules for all slices
.... extension:concept 0..1 CodeableConcept ExtCodeableReference
URL: https://nw-gmsa.github.io/StructureDefinition/ext-codeable-reference

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ref-1errorReferenceSHALL 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'))

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
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:concept 0..1 CodeableConcept ExtCodeableReference
URL: https://nw-gmsa.github.io/StructureDefinition/ext-codeable-reference
... reference ΣC 0..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 Σ 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Reference.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ref-1errorReferenceSHALL 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

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron