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/conceptmap-uv-livd
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ConceptMap
Summary
Mandatory: 7 elements (9 nested mandatory elements)
Must-Support: 2 elements
Fixed Value: 2 elements
Prohibited: 21 elements
Slices
This structure defines the following Slices:
This structure is derived from ConceptMap
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ConceptMap | 0..* | LIVD ConceptMap | ||
url | 0..1 | uri | Logical URI to reference this concept map (globally unique) | |
identifier | 0..0 | |||
version | 0..0 | |||
name | 0..0 | |||
title | 0..0 | |||
status | 1..1 | code | ||
experimental | 0..0 | |||
date | 0..0 | |||
publisher | 0..0 | |||
contact | 0..0 | |||
description | 0..0 | |||
useContext | 0..0 | |||
jurisdiction | 0..0 | |||
purpose | 0..0 | |||
copyright | 0..0 | |||
source[x] | 1..1 | uri, canonical(ValueSet) | Identifies the source of the concepts which are being mapped | |
target[x] | 1..1 | uri, canonical(ValueSet) | Provides context to the mappings | |
group | 1..1 | BackboneElement | Same source and target systems | |
source | 0..0 | |||
sourceVersion | 0..0 | |||
target | 0..0 | |||
targetVersion | 0..0 | |||
element | 1..* | BackboneElement | Mappings for a Vendor Analyte Code from the source set | |
code | 1..1 | code | Identifies the Vendor Analyte Code being mapped | |
display | 1..1 | string | The Vendor Analyte Name | |
target | 0..* | BackboneElement | Identifies the LOINC code being mapped to | |
code | 1..1 | code | Code that identifies the LOINC Code | |
display | 1..1 | string | LOINC Long Name | |
equivalence | 1..1 | code | relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint | |
comment | 0..1 | string | Vendor Comment | |
dependsOn | I | BackboneElement | Other elements required for this mapping (from context) Slice: Unordered, Open by value:property livd-1: If the dependsOn is valued, either the code or display must be present | |
dependsOn | 1..1 | BackboneElement | The property for specimen | |
property | S | 1..1 | uri | Binding: ConceptMapLIVDDescriptionProperty (required) Fixed Value: specimen |
dependsOn | 1..1 | BackboneElement | The property for specimen | |
property | S | 1..1 | uri | Reference to property mapping depends on Binding: ConceptMapLIVDDescriptionProperty (required) Fixed Value: result |
system | 0..0 | |||
value | 1..1 | string | Value of the referenced element | |
display | 0..0 | |||
product | 0..0 | |||
unmapped | 0..0 | |||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ConceptMap | I | 0..* | LIVD ConceptMap | |
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 | Σ | 0..1 | uri | Logical URI to reference this concept map (globally unique) |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
source[x] | Σ | 1..1 | uri, canonical(ValueSet) | Identifies the source of the concepts which are being mapped |
target[x] | Σ | 1..1 | uri, canonical(ValueSet) | Provides context to the mappings |
group | I | 1..1 | BackboneElement | Same source and target systems |
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 |
element | I | 1..* | BackboneElement | Mappings for a Vendor Analyte Code from the source 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 |
code | 1..1 | code | Identifies the Vendor Analyte Code being mapped | |
display | 1..1 | string | The Vendor Analyte Name | |
target | I | 0..* | BackboneElement | Identifies the LOINC code being mapped to |
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 that identifies the LOINC Code | |
display | 1..1 | string | LOINC Long Name | |
equivalence | ?! | 1..1 | code | relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint Binding: ConceptMapEquivalence (required) |
comment | I | 0..1 | string | Vendor Comment |
dependsOn | I | BackboneElement | Other elements required for this mapping (from context) Slice: Unordered, Open by value:property livd-1: If the dependsOn is valued, either the code or display must be present | |
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 | uri | Reference to property mapping depends on | |
system | 0..1 | canonical(CodeSystem) | Code System (if necessary) | |
value | 1..1 | string | Value of the referenced element | |
display | 0..1 | string | Display for the code (if value is a code) | |
dependsOn | I | 1..1 | BackboneElement | The property for specimen |
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 | S | 1..1 | uri | Reference to property mapping depends on Binding: ConceptMapLIVDDescriptionProperty (required) Fixed Value: specimen |
system | 0..1 | canonical(CodeSystem) | Code System (if necessary) | |
value | 1..1 | string | Value of the referenced element | |
display | 0..1 | string | Display for the code (if value is a code) | |
dependsOn | I | 1..1 | BackboneElement | The property for specimen |
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 | S | 1..1 | uri | Reference to property mapping depends on Binding: ConceptMapLIVDDescriptionProperty (required) Fixed Value: result |
value | 1..1 | string | Value of the referenced element | |
Documentation for this format |
This structure is derived from ConceptMap
Summary
Mandatory: 7 elements (9 nested mandatory elements)
Must-Support: 2 elements
Fixed Value: 2 elements
Prohibited: 21 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from ConceptMap
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ConceptMap | 0..* | LIVD ConceptMap | ||
url | 0..1 | uri | Logical URI to reference this concept map (globally unique) | |
identifier | 0..0 | |||
version | 0..0 | |||
name | 0..0 | |||
title | 0..0 | |||
status | 1..1 | code | ||
experimental | 0..0 | |||
date | 0..0 | |||
publisher | 0..0 | |||
contact | 0..0 | |||
description | 0..0 | |||
useContext | 0..0 | |||
jurisdiction | 0..0 | |||
purpose | 0..0 | |||
copyright | 0..0 | |||
source[x] | 1..1 | uri, canonical(ValueSet) | Identifies the source of the concepts which are being mapped | |
target[x] | 1..1 | uri, canonical(ValueSet) | Provides context to the mappings | |
group | 1..1 | BackboneElement | Same source and target systems | |
source | 0..0 | |||
sourceVersion | 0..0 | |||
target | 0..0 | |||
targetVersion | 0..0 | |||
element | 1..* | BackboneElement | Mappings for a Vendor Analyte Code from the source set | |
code | 1..1 | code | Identifies the Vendor Analyte Code being mapped | |
display | 1..1 | string | The Vendor Analyte Name | |
target | 0..* | BackboneElement | Identifies the LOINC code being mapped to | |
code | 1..1 | code | Code that identifies the LOINC Code | |
display | 1..1 | string | LOINC Long Name | |
equivalence | 1..1 | code | relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint | |
comment | 0..1 | string | Vendor Comment | |
dependsOn | I | BackboneElement | Other elements required for this mapping (from context) Slice: Unordered, Open by value:property livd-1: If the dependsOn is valued, either the code or display must be present | |
dependsOn | 1..1 | BackboneElement | The property for specimen | |
property | S | 1..1 | uri | Binding: ConceptMapLIVDDescriptionProperty (required) Fixed Value: specimen |
dependsOn | 1..1 | BackboneElement | The property for specimen | |
property | S | 1..1 | uri | Reference to property mapping depends on Binding: ConceptMapLIVDDescriptionProperty (required) Fixed Value: result |
system | 0..0 | |||
value | 1..1 | string | Value of the referenced element | |
display | 0..0 | |||
product | 0..0 | |||
unmapped | 0..0 | |||
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ConceptMap | I | 0..* | LIVD ConceptMap | |
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 | Σ | 0..1 | uri | Logical URI to reference this concept map (globally unique) |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
source[x] | Σ | 1..1 | uri, canonical(ValueSet) | Identifies the source of the concepts which are being mapped |
target[x] | Σ | 1..1 | uri, canonical(ValueSet) | Provides context to the mappings |
group | I | 1..1 | BackboneElement | Same source and target systems |
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 |
element | I | 1..* | BackboneElement | Mappings for a Vendor Analyte Code from the source 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 |
code | 1..1 | code | Identifies the Vendor Analyte Code being mapped | |
display | 1..1 | string | The Vendor Analyte Name | |
target | I | 0..* | BackboneElement | Identifies the LOINC code being mapped to |
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 that identifies the LOINC Code | |
display | 1..1 | string | LOINC Long Name | |
equivalence | ?! | 1..1 | code | relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint Binding: ConceptMapEquivalence (required) |
comment | I | 0..1 | string | Vendor Comment |
dependsOn | I | BackboneElement | Other elements required for this mapping (from context) Slice: Unordered, Open by value:property livd-1: If the dependsOn is valued, either the code or display must be present | |
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 | uri | Reference to property mapping depends on | |
system | 0..1 | canonical(CodeSystem) | Code System (if necessary) | |
value | 1..1 | string | Value of the referenced element | |
display | 0..1 | string | Display for the code (if value is a code) | |
dependsOn | I | 1..1 | BackboneElement | The property for specimen |
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 | S | 1..1 | uri | Reference to property mapping depends on Binding: ConceptMapLIVDDescriptionProperty (required) Fixed Value: specimen |
system | 0..1 | canonical(CodeSystem) | Code System (if necessary) | |
value | 1..1 | string | Value of the referenced element | |
display | 0..1 | string | Display for the code (if value is a code) | |
dependsOn | I | 1..1 | BackboneElement | The property for specimen |
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 | S | 1..1 | uri | Reference to property mapping depends on Binding: ConceptMapLIVDDescriptionProperty (required) Fixed Value: result |
value | 1..1 | string | Value of the referenced element | |
Documentation for this format |
Other representations of profile: Schematron
Path | Name | Conformance | ValueSet |
ConceptMap.language | Language | preferred | Common Languages |
ConceptMap.status | PublicationStatus | required | PublicationStatus |
ConceptMap.group.element.target.equivalence | ConceptMapEquivalence | required | ConceptMapEquivalence |
ConceptMap.group.element.target.dependsOn.property | ConceptMapLIVDDescriptionProperty | required | ConceptMapLIVDDescriptionProperty |
ConceptMap.group.element.target.dependsOn.property | ConceptMapLIVDDescriptionProperty | required | ConceptMapLIVDDescriptionProperty |
ConceptMap.group.unmapped.mode | ConceptMapGroupUnmappedMode | required | ConceptMapGroupUnmappedMode |
Id | Path | Details | Requirements |
dom-2 | ConceptMap | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-4 | ConceptMap | 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 | ConceptMap | 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 | ConceptMap | A resource should have narrative for robust management : text.div.exists() | |
dom-5 | ConceptMap | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
cmd-0 | ConceptMap | 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 | ConceptMap.group | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | ConceptMap.group.element | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | ConceptMap.group.element.target | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
cmd-1 | ConceptMap.group.element.target | If the map is narrower or inexact, there SHALL be some comments : comment.exists() or equivalence.empty() or ((equivalence != 'narrower') and (equivalence != 'inexact')) | |
ele-1 | ConceptMap.group.element.target.dependsOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | ConceptMap.group.element.target.dependsOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | ConceptMap.group.element.target.dependsOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |