LOINC – IVD Test Code (LIVD) Mapping 0.2.0 - STU Ballot 1

This page is part of the Loinc/IVD Mapping FHIR IG (v0.2.0: STU 1 (FHIR R4) Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

StructureDefinition: LIVDConceptMap

The official URL for this profile is:

http://hl7.org/fhir/uv/livd/StructureDefinition/conceptmap-uv-livd

Formal Views of Profile Content

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

This structure is derived from ConceptMap

Summary

Mandatory: 8 elements (12 nested mandatory elements)
Must-Support: 24 elements
Fixed Value: 3 elements
Prohibited: 24 elements

Slices

This structure defines the following Slices:

  • The element ConceptMap.group.element.target.dependsOn is sliced based on the value of value:property

This structure is derived from ConceptMap

NameFlagsCard.TypeDescription & Constraintsdoco
.. ConceptMap 0..*LIVDConceptMap
... url S0..1uriLogical URI to reference this concept map (globally unique)
... identifier 0..0
... version 0..0
... name S1..1string
... title 0..0
... status S1..1code
... 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] S1..1uri, canonical(ValueSet)Identifies the source of the concepts which are being mapped
... target[x] S1..1uri, canonical(ValueSet)Provides context to the mappings
... group S1..1BackboneElementSame source and target systems
.... source 0..0
.... sourceVersion 0..0
.... target 0..0
.... targetVersion 0..0
.... element S1..*BackboneElementMappings for a Vendor Analyte Code from the source set
..... code S1..1codeIdentifies the Vendor Analyte Code being mapped
..... display S1..1stringThe Vendor Analyte Name
..... target S0..*BackboneElementIdentifies the LOINC code being mapped to
...... code S1..1codeCode that identifies the LOINC Code
...... display S1..1stringLOINC Long Name
...... equivalence S1..1coderelatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
...... comment S0..1stringVendor Comment
...... dependsOn SI(Slice Definition)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
....... specimen S1..1BackboneElementThe property for specimen
........ property S1..1uriFixed Value: specimen
........ system 0..0
........ value S1..1stringValue of the specimen property
........ display 0..0
....... result S1..1BackboneElementThe property for result
........ property S1..1uriReference to property mapping depends on
Fixed Value: result
........ system 0..0
........ value S1..1stringValue of the result property
........ display 0..0
....... other S0..1BackboneElementThe property for result
........ property S1..1uriReference to property mapping depends on
Fixed Value: other
........ system 0..0
........ value S1..1stringValue of the result property
........ display 0..0
...... product 0..0
.... unmapped 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ConceptMap I0..*LIVDConceptMap
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ0..1uriLogical URI to reference this concept map (globally unique)
... name SΣI1..1stringName for this concept map (computer friendly)
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... source[x] SΣ1..1Identifies the source of the concepts which are being mapped
.... sourceUriuri
.... sourceCanonicalcanonical(http://hl7.org/fhir/valueset.html)
... target[x] SΣ1..1Provides context to the mappings
.... targetUriuri
.... targetCanonicalcanonical(http://hl7.org/fhir/valueset.html)
... group SI1..1BackboneElementSame source and target systems
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... element SI1..*BackboneElementMappings for a Vendor Analyte Code from the source set
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code S1..1codeIdentifies the Vendor Analyte Code being mapped
..... display S1..1stringThe Vendor Analyte Name
..... target SI0..*BackboneElementIdentifies the LOINC code being mapped to
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... code S1..1codeCode that identifies the LOINC Code
...... display S1..1stringLOINC Long Name
...... equivalence ?!S1..1coderelatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
Binding: ConceptMapEquivalence (required)
...... comment SI0..1stringVendor Comment
...... dependsOn SI(Slice Definition)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
....... (All Slices) Content/Rules for all slices
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ property 1..1uriReference to property mapping depends on
........ system 0..1canonical(CodeSystem)Code System (if necessary)
........ value 1..1stringValue of the referenced element
........ display 0..1stringDisplay for the code (if value is a code)
....... specimen SI1..1BackboneElementThe property for specimen
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ property S1..1uriReference to property mapping depends on
Fixed Value: specimen
........ value S1..1stringValue of the specimen property
....... result SI1..1BackboneElementThe property for result
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ property S1..1uriReference to property mapping depends on
Fixed Value: result
........ value S1..1stringValue of the result property
....... other SI0..1BackboneElementThe property for result
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ property S1..1uriReference to property mapping depends on
Fixed Value: other
........ value S1..1stringValue of the result property

doco Documentation for this format

This structure is derived from ConceptMap

Summary

Mandatory: 8 elements (12 nested mandatory elements)
Must-Support: 24 elements
Fixed Value: 3 elements
Prohibited: 24 elements

Slices

This structure defines the following Slices:

  • The element ConceptMap.group.element.target.dependsOn is sliced based on the value of value:property

Differential View

This structure is derived from ConceptMap

NameFlagsCard.TypeDescription & Constraintsdoco
.. ConceptMap 0..*LIVDConceptMap
... url S0..1uriLogical URI to reference this concept map (globally unique)
... identifier 0..0
... version 0..0
... name S1..1string
... title 0..0
... status S1..1code
... 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] S1..1uri, canonical(ValueSet)Identifies the source of the concepts which are being mapped
... target[x] S1..1uri, canonical(ValueSet)Provides context to the mappings
... group S1..1BackboneElementSame source and target systems
.... source 0..0
.... sourceVersion 0..0
.... target 0..0
.... targetVersion 0..0
.... element S1..*BackboneElementMappings for a Vendor Analyte Code from the source set
..... code S1..1codeIdentifies the Vendor Analyte Code being mapped
..... display S1..1stringThe Vendor Analyte Name
..... target S0..*BackboneElementIdentifies the LOINC code being mapped to
...... code S1..1codeCode that identifies the LOINC Code
...... display S1..1stringLOINC Long Name
...... equivalence S1..1coderelatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
...... comment S0..1stringVendor Comment
...... dependsOn SI(Slice Definition)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
....... specimen S1..1BackboneElementThe property for specimen
........ property S1..1uriFixed Value: specimen
........ system 0..0
........ value S1..1stringValue of the specimen property
........ display 0..0
....... result S1..1BackboneElementThe property for result
........ property S1..1uriReference to property mapping depends on
Fixed Value: result
........ system 0..0
........ value S1..1stringValue of the result property
........ display 0..0
....... other S0..1BackboneElementThe property for result
........ property S1..1uriReference to property mapping depends on
Fixed Value: other
........ system 0..0
........ value S1..1stringValue of the result property
........ display 0..0
...... product 0..0
.... unmapped 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ConceptMap I0..*LIVDConceptMap
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ0..1uriLogical URI to reference this concept map (globally unique)
... name SΣI1..1stringName for this concept map (computer friendly)
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... source[x] SΣ1..1Identifies the source of the concepts which are being mapped
.... sourceUriuri
.... sourceCanonicalcanonical(http://hl7.org/fhir/valueset.html)
... target[x] SΣ1..1Provides context to the mappings
.... targetUriuri
.... targetCanonicalcanonical(http://hl7.org/fhir/valueset.html)
... group SI1..1BackboneElementSame source and target systems
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... element SI1..*BackboneElementMappings for a Vendor Analyte Code from the source set
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code S1..1codeIdentifies the Vendor Analyte Code being mapped
..... display S1..1stringThe Vendor Analyte Name
..... target SI0..*BackboneElementIdentifies the LOINC code being mapped to
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... code S1..1codeCode that identifies the LOINC Code
...... display S1..1stringLOINC Long Name
...... equivalence ?!S1..1coderelatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
Binding: ConceptMapEquivalence (required)
...... comment SI0..1stringVendor Comment
...... dependsOn SI(Slice Definition)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
....... (All Slices) Content/Rules for all slices
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ property 1..1uriReference to property mapping depends on
........ system 0..1canonical(CodeSystem)Code System (if necessary)
........ value 1..1stringValue of the referenced element
........ display 0..1stringDisplay for the code (if value is a code)
....... specimen SI1..1BackboneElementThe property for specimen
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ property S1..1uriReference to property mapping depends on
Fixed Value: specimen
........ value S1..1stringValue of the specimen property
....... result SI1..1BackboneElementThe property for result
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ property S1..1uriReference to property mapping depends on
Fixed Value: result
........ value S1..1stringValue of the result property
....... other SI0..1BackboneElementThe property for result
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ property S1..1uriReference to property mapping depends on
Fixed Value: other
........ value S1..1stringValue of the result property

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet
ConceptMap.languagepreferredCommonLanguages
Max Binding: AllLanguages
ConceptMap.statusrequiredPublicationStatus
ConceptMap.group.element.target.equivalencerequiredConceptMapEquivalence
ConceptMap.group.unmapped.moderequiredConceptMapGroupUnmappedMode

Constraints

IdPathDetailsRequirements
dom-2ConceptMapIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-4ConceptMapIf 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-3ConceptMapIf 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-6ConceptMapA resource should have narrative for robust management
: text.div.exists()
dom-5ConceptMapIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
cmd-0ConceptMapName 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-1ConceptMap.groupAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ConceptMap.group.elementAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ConceptMap.group.element.targetAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
cmd-1ConceptMap.group.element.targetIf the map is narrower or inexact, there SHALL be some comments
: comment.exists() or equivalence.empty() or ((equivalence != 'narrower') and (equivalence != 'inexact'))
ele-1ConceptMap.group.element.target.dependsOnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ConceptMap.group.element.target.dependsOnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ConceptMap.group.element.target.dependsOnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ConceptMap.group.element.target.dependsOnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())