This page is part of the Loinc/IVD Mapping FHIR IG (v0.1.0: STU 1 Draft) based on FHIR v3.5.0. . For a full list of available versions, see the Directory of published versions
This is a pre-release version (Draft for Comment) of Loinc/IVD Mapping (LIVD) R1 (STU). There is no current official version.
For a full list of available versions, see the Directory of published versions .
The official URL for this profile is:
http://hl7.org/fhir/uv/livd/StructureDefinition/valueset-uv-livd
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ValueSet
This structure is derived from ValueSet
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ValueSet | 0..* | LIVD ValueSet | ||
url | 1..1 | uri | ||
identifier | 0..0 | |||
version | 0..1 | string | ||
name | 0..1 | string | ||
title | 0..1 | string | ||
status | 1..1 | code | ||
experimental | 0..1 | boolean | ||
date | 0..1 | dateTime | ||
publisher | 0..1 | string | ||
contact | 0..* | ContactDetail | ||
description | 0..1 | markdown | ||
useContext | 0..* | UsageContext | ||
jurisdiction | 0..* | CodeableConcept | ||
immutable | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur | |
purpose | 0..1 | markdown | ||
copyright | 0..1 | markdown | ||
compose | 0..1 | BackboneElement | Definition of the content of the value set | |
lockedDate | 0..1 | date | Fixed date for version-less references (transitive) | |
inactive | 0..1 | boolean | Whether inactive codes are in the value set | |
include | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) | |
system | 0..1 | uri | The system the codes come from | |
version | 0..1 | string | Specific version of the code system referred to | |
concept | 0..* | BackboneElement | A concept defined in the system | |
code | 1..1 | code | Code or expression from system | |
display | 0..1 | string | Text to display for this code for this value set in this valueset | |
designation | 0..* | BackboneElement | Additional representations for this concept | |
language | 0..1 | code | Human language of the designation | |
use | 0..1 | Coding | Details how this designation would be used | |
value | 1..1 | string | The text value for this designation | |
filter | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) | |
property | 1..1 | code | A property defined by the code system | |
op | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists | |
value | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists | |
valueSet | 0..* | canonical(ValueSet) | Select the contents included in this value set | |
exclude | 0..* | Explicitly exclude codes from a code system or other value sets | ||
expansion | 0..1 | BackboneElement | Used when the value set is "expanded" | |
identifier | 0..1 | uri | Uniquely identifies this expansion | |
timestamp | 1..1 | dateTime | Time ValueSet expansion happened | |
total | 0..1 | integer | Total number of codes in the expansion | |
offset | 0..1 | integer | Offset at which this resource starts | |
parameter | 0..* | BackboneElement | Parameter that controlled the expansion process | |
name | 1..1 | string | Name as assigned by the server | |
value[x] | 0..1 | string, boolean, integer, decimal, uri, code, dateTime | Value of the named parameter | |
contains | 0..* | BackboneElement | Codes in the value set | |
system | 0..1 | uri | System value for the code | |
abstract | 0..1 | boolean | If user cannot select this entry | |
inactive | 0..1 | boolean | If concept is inactive in the code system | |
version | 0..1 | string | Version in which this code/display is defined | |
code | 0..1 | code | Code - if blank, this is not a selectable code | |
display | 0..1 | string | User display for the concept | |
designation | 0..* | Additional representations for this item | ||
contains | 0..* | Codes contained under this entry | ||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ValueSet | I | 0..* | LIVD ValueSet | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (preferred) | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | Σ | 1..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) |
version | Σ | 0..1 | string | Business version of the value set |
name | ΣI | 0..1 | string | Name for this value set (computer friendly) |
title | Σ | 0..1 | string | Name for this value set (human friendly) |
status | ?!ΣI | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
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 value set | |
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: Jurisdiction ValueSet (extensible) |
immutable | Σ | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur |
purpose | 0..1 | markdown | Why this value set is defined | |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
compose | I | 0..1 | BackboneElement | Definition of the content of the value set |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
lockedDate | Σ | 0..1 | date | Fixed date for version-less references (transitive) |
inactive | Σ | 0..1 | boolean | Whether inactive codes are in the value set |
include | ΣI | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
system | ΣI | 0..1 | uri | The system the codes come from |
version | Σ | 0..1 | string | Specific version of the code system referred to |
concept | I | 0..* | BackboneElement | A concept defined in the system |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
code | 1..1 | code | Code or expression from system | |
display | 0..1 | string | Text to display for this code for this value set in this valueset | |
designation | I | 0..* | BackboneElement | Additional representations for this concept |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
language | 0..1 | code | Human language of the designation Binding: Common Languages (preferred) | |
use | 0..1 | Coding | Details how this designation would be used Binding: DesignationUse (extensible) | |
value | 1..1 | string | The text value for this designation | |
filter | ΣI | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
property | Σ | 1..1 | code | A property defined by the code system |
op | Σ | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists Binding: FilterOperator (required) |
value | Σ | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists |
valueSet | ΣI | 0..* | canonical(ValueSet) | Select the contents included in this value set |
exclude | I | 0..* | Unknown reference to #ValueSet.compose.include Explicitly exclude codes from a code system or other value sets | |
expansion | I | 0..1 | BackboneElement | Used when the value set is "expanded" |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
identifier | 0..1 | uri | Uniquely identifies this expansion | |
timestamp | 1..1 | dateTime | Time ValueSet expansion happened | |
total | 0..1 | integer | Total number of codes in the expansion | |
offset | 0..1 | integer | Offset at which this resource starts | |
parameter | I | 0..* | BackboneElement | Parameter that controlled the expansion process |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
name | 1..1 | string | Name as assigned by the server | |
value[x] | 0..1 | string, boolean, integer, decimal, uri, code, dateTime | Value of the named parameter | |
contains | I | 0..* | BackboneElement | Codes in the value set |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
system | 0..1 | uri | System value for the code | |
abstract | 0..1 | boolean | If user cannot select this entry | |
inactive | 0..1 | boolean | If concept is inactive in the code system | |
version | 0..1 | string | Version in which this code/display is defined | |
code | I | 0..1 | code | Code - if blank, this is not a selectable code |
display | I | 0..1 | string | User display for the concept |
designation | 0..* | Unknown reference to #ValueSet.compose.include.concept.designation Additional representations for this item | ||
contains | 0..* | Unknown reference to #ValueSet.expansion.contains Codes contained under this entry | ||
Documentation for this format |
This structure is derived from ValueSet
Differential View
This structure is derived from ValueSet
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ValueSet | 0..* | LIVD ValueSet | ||
url | 1..1 | uri | ||
identifier | 0..0 | |||
version | 0..1 | string | ||
name | 0..1 | string | ||
title | 0..1 | string | ||
status | 1..1 | code | ||
experimental | 0..1 | boolean | ||
date | 0..1 | dateTime | ||
publisher | 0..1 | string | ||
contact | 0..* | ContactDetail | ||
description | 0..1 | markdown | ||
useContext | 0..* | UsageContext | ||
jurisdiction | 0..* | CodeableConcept | ||
immutable | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur | |
purpose | 0..1 | markdown | ||
copyright | 0..1 | markdown | ||
compose | 0..1 | BackboneElement | Definition of the content of the value set | |
lockedDate | 0..1 | date | Fixed date for version-less references (transitive) | |
inactive | 0..1 | boolean | Whether inactive codes are in the value set | |
include | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) | |
system | 0..1 | uri | The system the codes come from | |
version | 0..1 | string | Specific version of the code system referred to | |
concept | 0..* | BackboneElement | A concept defined in the system | |
code | 1..1 | code | Code or expression from system | |
display | 0..1 | string | Text to display for this code for this value set in this valueset | |
designation | 0..* | BackboneElement | Additional representations for this concept | |
language | 0..1 | code | Human language of the designation | |
use | 0..1 | Coding | Details how this designation would be used | |
value | 1..1 | string | The text value for this designation | |
filter | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) | |
property | 1..1 | code | A property defined by the code system | |
op | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists | |
value | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists | |
valueSet | 0..* | canonical(ValueSet) | Select the contents included in this value set | |
exclude | 0..* | Explicitly exclude codes from a code system or other value sets | ||
expansion | 0..1 | BackboneElement | Used when the value set is "expanded" | |
identifier | 0..1 | uri | Uniquely identifies this expansion | |
timestamp | 1..1 | dateTime | Time ValueSet expansion happened | |
total | 0..1 | integer | Total number of codes in the expansion | |
offset | 0..1 | integer | Offset at which this resource starts | |
parameter | 0..* | BackboneElement | Parameter that controlled the expansion process | |
name | 1..1 | string | Name as assigned by the server | |
value[x] | 0..1 | string, boolean, integer, decimal, uri, code, dateTime | Value of the named parameter | |
contains | 0..* | BackboneElement | Codes in the value set | |
system | 0..1 | uri | System value for the code | |
abstract | 0..1 | boolean | If user cannot select this entry | |
inactive | 0..1 | boolean | If concept is inactive in the code system | |
version | 0..1 | string | Version in which this code/display is defined | |
code | 0..1 | code | Code - if blank, this is not a selectable code | |
display | 0..1 | string | User display for the concept | |
designation | 0..* | Additional representations for this item | ||
contains | 0..* | Codes contained under this entry | ||
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ValueSet | I | 0..* | LIVD ValueSet | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (preferred) | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | Σ | 1..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) |
version | Σ | 0..1 | string | Business version of the value set |
name | ΣI | 0..1 | string | Name for this value set (computer friendly) |
title | Σ | 0..1 | string | Name for this value set (human friendly) |
status | ?!ΣI | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
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 value set | |
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: Jurisdiction ValueSet (extensible) |
immutable | Σ | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur |
purpose | 0..1 | markdown | Why this value set is defined | |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
compose | I | 0..1 | BackboneElement | Definition of the content of the value set |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
lockedDate | Σ | 0..1 | date | Fixed date for version-less references (transitive) |
inactive | Σ | 0..1 | boolean | Whether inactive codes are in the value set |
include | ΣI | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
system | ΣI | 0..1 | uri | The system the codes come from |
version | Σ | 0..1 | string | Specific version of the code system referred to |
concept | I | 0..* | BackboneElement | A concept defined in the system |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
code | 1..1 | code | Code or expression from system | |
display | 0..1 | string | Text to display for this code for this value set in this valueset | |
designation | I | 0..* | BackboneElement | Additional representations for this concept |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
language | 0..1 | code | Human language of the designation Binding: Common Languages (preferred) | |
use | 0..1 | Coding | Details how this designation would be used Binding: DesignationUse (extensible) | |
value | 1..1 | string | The text value for this designation | |
filter | ΣI | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
property | Σ | 1..1 | code | A property defined by the code system |
op | Σ | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists Binding: FilterOperator (required) |
value | Σ | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists |
valueSet | ΣI | 0..* | canonical(ValueSet) | Select the contents included in this value set |
exclude | I | 0..* | Unknown reference to #ValueSet.compose.include Explicitly exclude codes from a code system or other value sets | |
expansion | I | 0..1 | BackboneElement | Used when the value set is "expanded" |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
identifier | 0..1 | uri | Uniquely identifies this expansion | |
timestamp | 1..1 | dateTime | Time ValueSet expansion happened | |
total | 0..1 | integer | Total number of codes in the expansion | |
offset | 0..1 | integer | Offset at which this resource starts | |
parameter | I | 0..* | BackboneElement | Parameter that controlled the expansion process |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
name | 1..1 | string | Name as assigned by the server | |
value[x] | 0..1 | string, boolean, integer, decimal, uri, code, dateTime | Value of the named parameter | |
contains | I | 0..* | BackboneElement | Codes in the value set |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
system | 0..1 | uri | System value for the code | |
abstract | 0..1 | boolean | If user cannot select this entry | |
inactive | 0..1 | boolean | If concept is inactive in the code system | |
version | 0..1 | string | Version in which this code/display is defined | |
code | I | 0..1 | code | Code - if blank, this is not a selectable code |
display | I | 0..1 | string | User display for the concept |
designation | 0..* | Unknown reference to #ValueSet.compose.include.concept.designation Additional representations for this item | ||
contains | 0..* | Unknown reference to #ValueSet.expansion.contains Codes contained under this entry | ||
Documentation for this format |
Other representations of profile: Schematron
Path | Name | Conformance | ValueSet |
ValueSet.language | Language | preferred | Common Languages |
ValueSet.status | PublicationStatus | required | PublicationStatus |
ValueSet.jurisdiction | Jurisdiction | extensible | Jurisdiction ValueSet |
ValueSet.compose.include.concept.designation.language | Language | preferred | Common Languages |
ValueSet.compose.include.concept.designation.use | Designation Use | extensible | DesignationUse |
ValueSet.compose.include.filter.op | FilterOperator | required | FilterOperator |
Id | Path | Details | Requirements |
dom-2 | ValueSet | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-4 | ValueSet | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-3 | ValueSet | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-6 | ValueSet | A resource should have narrative for robust management : text.div.exists() | |
dom-5 | ValueSet | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
vsd-11 | ValueSet | Status must = 'active' if expansion is present and compose is absent : status='active' or compose.exists() or expansion.empty() | |
vsd-0 | ValueSet | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') | |
ele-1 | ValueSet.compose | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | ValueSet.compose.include | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
vsd-2 | ValueSet.compose.include | A value set with concepts or filters SHALL include a system : (concept.exists() or filter.exists()) implies system.exists() | |
vsd-3 | ValueSet.compose.include | Cannot have both concept and filter : concept.empty() or filter.empty() | |
vsd-1 | ValueSet.compose.include | A value set include/exclude SHALL have a value set or a system : valueSet.exists() or system.exists() | |
ele-1 | ValueSet.compose.include.concept | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | ValueSet.compose.include.concept.designation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | ValueSet.compose.include.filter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | ValueSet.expansion | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | ValueSet.expansion.parameter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | ValueSet.expansion.contains | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
vsd-6 | ValueSet.expansion.contains | SHALL have a code or a display : code.exists() or display.exists() | |
vsd-9 | ValueSet.expansion.contains | Must have a code if not abstract : code.exists() or abstract = true | |
vsd-10 | ValueSet.expansion.contains | Must have a system if a code is present : code.empty() or system.exists() |