LOINC – IVD Test Code (LIVD) Mapping
1.0.0-ballot - ballot
LOINC – IVD Test Code (LIVD) Mapping
1.0.0-ballot - ballot
LOINC – IVD Test Code (LIVD) Mapping, published by HL7 International / Orders and Observations. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/livd/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/livd/StructureDefinition/conceptmap-testcode-uv-livd | Version: 1.0.0-ballot | |||
| Active as of 2018-08-14 | Computable Name: LIVDTestCodeConceptMap | |||
ConceptMap profile for mappoings of manufacturer IVD test codes to standard LOINC codes.
The LIVD Test Code ConceptMap is a profile on the ConceptMap resource for representing the test code mappings from a vendor IVD analyte code to a LOINC code.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ConceptMap
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ConceptMap |
0..* | ConceptMap | LIVDTestCodeConceptMap | |
  url |
S | 0..1 | uri | Canonical identifier for this concept map, represented as a URI (globally unique) |
| identifier |
0..0 | |||
| version |
0..0 | |||
| name |
S | 1..1 | string | Name for this concept map (computer friendly) |
| title |
0..0 | |||
| status |
S | 1..1 | code | draft | active | retired | unknown |
| experimental |
0..0 | |||
| date |
0..1 | dateTime | Date last changed | |
| publisher |
0..0 | |||
| contact |
0..0 | |||
| description |
0..0 | |||
| useContext |
0..0 | |||
| jurisdiction |
0..* | CodeableConcept | Intended jurisdiction for concept map (if applicable) | |
| purpose |
0..0 | |||
| copyright |
0..0 | |||
| source[x] |
S | 1..1 | uri, canonical(ValueSet) | The source value set that contains the concepts that are being mapped |
| target[x] |
S | 1..1 | uri, canonical(ValueSet) | The target value set which provides context for the mappings |
 group |
S | 1..1 | BackboneElement | Same source and target systems |
 source |
0..0 | |||
| sourceVersion |
0..0 | |||
| targetVersion |
S | 0..1 | string | Specific version of the code system |
 element |
S | 1..* | BackboneElement | Mappings for a Vendor Analyte Code from the source set |
 code |
S | 1..1 | code | Identifies the Vendor Analyte Code being mapped |
| display |
S | 1..1 | string | The Vendor Analyte Name |
| target |
S | 0..* | BackboneElement | Identifies the LOINC code being mapped to |
| code |
S | 1..1 | code | Code that identifies the LOINC Code |
| display |
S | 1..1 | string | LOINC Long Name |
| equivalence |
S | 1..1 | code | relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint |
| comment |
S | 0..1 | string | Vendor Comment |
 Slices for dependsOn |
SC | 0..4 | BackboneElement | Other elements required for this mapping (from context) Slice: Unordered, Open by value:property |
  dependsOn:specimen |
S | 0..1 | BackboneElement | The property for specimen |
  property |
S | 1..1 | uri | Reference to property mapping depends on Fixed Value: specimen |
| system |
0..0 | |||
| value |
S | 1..1 | string | Value of the specimen property |
 display |
0..0 | |||
| dependsOn:result |
S | 0..1 | BackboneElement | The property for result |
| property |
S | 1..1 | uri | Reference to property mapping depends on Fixed Value: result |
| system |
0..0 | |||
| value |
S | 1..1 | string | Value of the result property |
| display |
0..0 | |||
| dependsOn:device |
S | 0..1 | BackboneElement | The property for device |
| property |
S | 1..1 | uri | Reference to property mapping depends on Fixed Value: device |
| system |
0..0 | |||
| value |
S | 1..1 | string | Value of the device property |
| display |
0..0 | |||
 dependsOn:other |
S | 0..1 | BackboneElement | The property for other |
| property |
S | 1..1 | uri | Reference to property mapping depends on Fixed Value: other |
| system |
0..0 | |||
| value |
S | 1..1 | string | Value of the other value property |
| display |
0..0 | |||
 product |
0..0 | |||
| unmapped |
0..0 | |||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| livd-1 | error | **ALL** elements | If the dependsOn is valued, either the code or display must be present : (group.element.target.dependsOn.exists() and (group.element.target.code.exists() or group.element.target.display.exists())) or group.element.target.dependsOn.empty() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ConceptMap |
C | 0..* | ConceptMap | LIVDTestCodeConceptMap cmd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| url |
SΣ | 0..1 | uri | Canonical identifier for this concept map, represented as a URI (globally unique) ele-1: All FHIR elements must have a @value or children |
| name |
SΣC | 1..1 | string | Name for this concept map (computer friendly) ele-1: All FHIR elements must have a @value or children |
| status |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. ele-1: All FHIR elements must have a @value or children |
| date |
Σ | 0..1 | dateTime | Date last changed ele-1: All FHIR elements must have a @value or children |
 jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for concept map (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. ele-1: All FHIR elements must have a @value or children |
 source[x] |
SΣ | 1..1 | The source value set that contains the concepts that are being mapped ele-1: All FHIR elements must have a @value or children | |
| sourceUri |
uri | |||
 sourceCanonical |
canonical(ValueSet) | |||
| target[x] |
SΣ | 1..1 | The target value set which provides context for the mappings ele-1: All FHIR elements must have a @value or children | |
| targetUri |
uri | |||
| targetCanonical |
canonical(ValueSet) | |||
| group |
S | 1..1 | BackboneElement | Same source and target systems ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| targetVersion |
S | 0..1 | string | Specific version of the code system ele-1: All FHIR elements must have a @value or children |
| element |
S | 1..* | BackboneElement | Mappings for a Vendor Analyte Code from the source set ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| code |
S | 1..1 | code | Identifies the Vendor Analyte Code being mapped ele-1: All FHIR elements must have a @value or children |
| display |
S | 1..1 | string | The Vendor Analyte Name ele-1: All FHIR elements must have a @value or children |
| target |
SC | 0..* | BackboneElement | Identifies the LOINC code being mapped to cmd-1: If the map is narrower or inexact, there SHALL be some comments ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| code |
S | 1..1 | code | Code that identifies the LOINC Code ele-1: All FHIR elements must have a @value or children |
| display |
S | 1..1 | string | LOINC Long Name ele-1: All FHIR elements must have a @value or children |
| equivalence |
?!S | 1..1 | code | relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint Binding: ConceptMapEquivalence (required): The degree of equivalence between concepts. ele-1: All FHIR elements must have a @value or children |
| comment |
SC | 0..1 | string | Vendor Comment ele-1: All FHIR elements must have a @value or children |
| Slices for dependsOn |
SC | 0..4 | BackboneElement | Other elements required for this mapping (from context) Slice: Unordered, Open by value:property ele-1: All FHIR elements must have a @value or children livd-1: If the dependsOn is valued, either the code or display must be present |
| dependsOn:All Slices |
Content/Rules for all slices | |||
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| property |
1..1 | uri | Reference to property mapping depends on ele-1: All FHIR elements must have a @value or children | |
 value |
1..1 | string | Value of the referenced element ele-1: All FHIR elements must have a @value or children | |
| dependsOn:specimen |
S | 0..1 | BackboneElement | The property for specimen ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| property |
S | 1..1 | uri | Reference to property mapping depends on ele-1: All FHIR elements must have a @value or children Fixed Value: specimen |
| value |
S | 1..1 | string | Value of the specimen property ele-1: All FHIR elements must have a @value or children |
| dependsOn:result |
S | 0..1 | BackboneElement | The property for result ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| property |
S | 1..1 | uri | Reference to property mapping depends on ele-1: All FHIR elements must have a @value or children Fixed Value: result |
| value |
S | 1..1 | string | Value of the result property ele-1: All FHIR elements must have a @value or children |
| dependsOn:device |
S | 0..1 | BackboneElement | The property for device ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| property |
S | 1..1 | uri | Reference to property mapping depends on ele-1: All FHIR elements must have a @value or children Fixed Value: device |
| value |
S | 1..1 | string | Value of the device property ele-1: All FHIR elements must have a @value or children |
| dependsOn:other |
S | 0..1 | BackboneElement | The property for other ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| property |
S | 1..1 | uri | Reference to property mapping depends on ele-1: All FHIR elements must have a @value or children Fixed Value: other |
| value |
S | 1..1 | string | Value of the other value property ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ConceptMap.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | |
| ConceptMap.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | |
| ConceptMap.group.element.target.equivalence | required | ConceptMapEquivalencehttp://hl7.org/fhir/ValueSet/concept-map-equivalence|4.0.1from the FHIR Standard | |
| ConceptMap.group.unmapped.mode | required | ConceptMapGroupUnmappedModehttp://hl7.org/fhir/ValueSet/conceptmap-unmapped-mode|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cmd-0 | warning | 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}') | |
| cmd-1 | error | 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')) | |
| dom-2 | error | ConceptMap | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | 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-4 | error | 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-5 | error | ConceptMap | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ConceptMap | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| livd-1 | error | **ALL** elements | If the dependsOn is valued, either the code or display must be present : (group.element.target.dependsOn.exists() and (group.element.target.code.exists() or group.element.target.display.exists())) or group.element.target.dependsOn.empty() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ConceptMap |
C | 0..* | ConceptMap | LIVDTestCodeConceptMap cmd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation | ||||
| 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: CommonLanguages (preferred): A human language.
| |||||
| 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 |
SΣ | 0..1 | uri | Canonical identifier for this concept map, represented as a URI (globally unique) | ||||
| name |
SΣC | 1..1 | string | Name for this concept map (computer friendly) | ||||
| status |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| date |
Σ | 0..1 | dateTime | Date last changed | ||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for concept map (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| source[x] |
SΣ | 1..1 | The source value set that contains the concepts that are being mapped | |||||
| sourceUri |
uri | |||||||
| sourceCanonical |
canonical(ValueSet) | |||||||
| target[x] |
SΣ | 1..1 | The target value set which provides context for the mappings | |||||
| targetUri |
uri | |||||||
| targetCanonical |
canonical(ValueSet) | |||||||
| group |
S | 1..1 | BackboneElement | Same source and target systems | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| target |
0..1 | uri | Target system that the concepts are to be mapped to | |||||
| targetVersion |
S | 0..1 | string | Specific version of the code system | ||||
| element |
S | 1..* | BackboneElement | Mappings for a Vendor Analyte Code from the source set | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
S | 1..1 | code | Identifies the Vendor Analyte Code being mapped | ||||
| display |
S | 1..1 | string | The Vendor Analyte Name | ||||
| target |
SC | 0..* | BackboneElement | Identifies the LOINC code being mapped to cmd-1: If the map is narrower or inexact, there SHALL be some comments | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
S | 1..1 | code | Code that identifies the LOINC Code | ||||
| display |
S | 1..1 | string | LOINC Long Name | ||||
| equivalence |
?!S | 1..1 | code | relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint Binding: ConceptMapEquivalence (required): The degree of equivalence between concepts. | ||||
| comment |
SC | 0..1 | string | Vendor Comment | ||||
| Slices for dependsOn |
SC | 0..4 | BackboneElement | Other elements required for this mapping (from context) Slice: Unordered, Open by value:property | ||||
| dependsOn:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even 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:specimen |
S | 0..1 | BackboneElement | The property for specimen | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| property |
S | 1..1 | uri | Reference to property mapping depends on Fixed Value: specimen | ||||
| value |
S | 1..1 | string | Value of the specimen property | ||||
| dependsOn:result |
S | 0..1 | BackboneElement | The property for result | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| property |
S | 1..1 | uri | Reference to property mapping depends on Fixed Value: result | ||||
| value |
S | 1..1 | string | Value of the result property | ||||
| dependsOn:device |
S | 0..1 | BackboneElement | The property for device | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| property |
S | 1..1 | uri | Reference to property mapping depends on Fixed Value: device | ||||
| value |
S | 1..1 | string | Value of the device property | ||||
| dependsOn:other |
S | 0..1 | BackboneElement | The property for other | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| property |
S | 1..1 | uri | Reference to property mapping depends on Fixed Value: other | ||||
| value |
S | 1..1 | string | Value of the other value property | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| ConceptMap.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| ConceptMap.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | ||||
| ConceptMap.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | ||||
| ConceptMap.group.element.target.equivalence | required | ConceptMapEquivalencehttp://hl7.org/fhir/ValueSet/concept-map-equivalence|4.0.1from the FHIR Standard | ||||
| ConceptMap.group.unmapped.mode | required | ConceptMapGroupUnmappedModehttp://hl7.org/fhir/ValueSet/conceptmap-unmapped-mode|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cmd-0 | warning | 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}') | |
| cmd-1 | error | 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')) | |
| dom-2 | error | ConceptMap | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | 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-4 | error | 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-5 | error | ConceptMap | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ConceptMap | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| livd-1 | error | **ALL** elements | If the dependsOn is valued, either the code or display must be present : (group.element.target.dependsOn.exists() and (group.element.target.code.exists() or group.element.target.display.exists())) or group.element.target.dependsOn.empty() |
This structure is derived from ConceptMap
Summary
Mandatory: 6 elements(2 nested mandatory elements)
Must-Support: 28 elements
Fixed: 4 elements
Prohibited: 22 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from ConceptMap
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ConceptMap |
0..* | ConceptMap | LIVDTestCodeConceptMap | |
| url |
S | 0..1 | uri | Canonical identifier for this concept map, represented as a URI (globally unique) |
| identifier |
0..0 | |||
| version |
0..0 | |||
| name |
S | 1..1 | string | Name for this concept map (computer friendly) |
| title |
0..0 | |||
| status |
S | 1..1 | code | draft | active | retired | unknown |
| experimental |
0..0 | |||
| date |
0..1 | dateTime | Date last changed | |
| publisher |
0..0 | |||
| contact |
0..0 | |||
| description |
0..0 | |||
| useContext |
0..0 | |||
| jurisdiction |
0..* | CodeableConcept | Intended jurisdiction for concept map (if applicable) | |
| purpose |
0..0 | |||
| copyright |
0..0 | |||
| source[x] |
S | 1..1 | uri, canonical(ValueSet) | The source value set that contains the concepts that are being mapped |
| target[x] |
S | 1..1 | uri, canonical(ValueSet) | The target value set which provides context for the mappings |
| group |
S | 1..1 | BackboneElement | Same source and target systems |
| source |
0..0 | |||
| sourceVersion |
0..0 | |||
| targetVersion |
S | 0..1 | string | Specific version of the code system |
| element |
S | 1..* | BackboneElement | Mappings for a Vendor Analyte Code from the source set |
| code |
S | 1..1 | code | Identifies the Vendor Analyte Code being mapped |
| display |
S | 1..1 | string | The Vendor Analyte Name |
| target |
S | 0..* | BackboneElement | Identifies the LOINC code being mapped to |
| code |
S | 1..1 | code | Code that identifies the LOINC Code |
| display |
S | 1..1 | string | LOINC Long Name |
| equivalence |
S | 1..1 | code | relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint |
| comment |
S | 0..1 | string | Vendor Comment |
| Slices for dependsOn |
SC | 0..4 | BackboneElement | Other elements required for this mapping (from context) Slice: Unordered, Open by value:property |
| dependsOn:specimen |
S | 0..1 | BackboneElement | The property for specimen |
| property |
S | 1..1 | uri | Reference to property mapping depends on Fixed Value: specimen |
| system |
0..0 | |||
| value |
S | 1..1 | string | Value of the specimen property |
| display |
0..0 | |||
| dependsOn:result |
S | 0..1 | BackboneElement | The property for result |
| property |
S | 1..1 | uri | Reference to property mapping depends on Fixed Value: result |
| system |
0..0 | |||
| value |
S | 1..1 | string | Value of the result property |
| display |
0..0 | |||
| dependsOn:device |
S | 0..1 | BackboneElement | The property for device |
| property |
S | 1..1 | uri | Reference to property mapping depends on Fixed Value: device |
| system |
0..0 | |||
| value |
S | 1..1 | string | Value of the device property |
| display |
0..0 | |||
| dependsOn:other |
S | 0..1 | BackboneElement | The property for other |
| property |
S | 1..1 | uri | Reference to property mapping depends on Fixed Value: other |
| system |
0..0 | |||
| value |
S | 1..1 | string | Value of the other value property |
| display |
0..0 | |||
| product |
0..0 | |||
| unmapped |
0..0 | |||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| livd-1 | error | **ALL** elements | If the dependsOn is valued, either the code or display must be present : (group.element.target.dependsOn.exists() and (group.element.target.code.exists() or group.element.target.display.exists())) or group.element.target.dependsOn.empty() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ConceptMap |
C | 0..* | ConceptMap | LIVDTestCodeConceptMap cmd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| url |
SΣ | 0..1 | uri | Canonical identifier for this concept map, represented as a URI (globally unique) ele-1: All FHIR elements must have a @value or children |
| name |
SΣC | 1..1 | string | Name for this concept map (computer friendly) ele-1: All FHIR elements must have a @value or children |
| status |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. ele-1: All FHIR elements must have a @value or children |
| date |
Σ | 0..1 | dateTime | Date last changed ele-1: All FHIR elements must have a @value or children |
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for concept map (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. ele-1: All FHIR elements must have a @value or children |
| source[x] |
SΣ | 1..1 | The source value set that contains the concepts that are being mapped ele-1: All FHIR elements must have a @value or children | |
| sourceUri |
uri | |||
| sourceCanonical |
canonical(ValueSet) | |||
| target[x] |
SΣ | 1..1 | The target value set which provides context for the mappings ele-1: All FHIR elements must have a @value or children | |
| targetUri |
uri | |||
| targetCanonical |
canonical(ValueSet) | |||
| group |
S | 1..1 | BackboneElement | Same source and target systems ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| targetVersion |
S | 0..1 | string | Specific version of the code system ele-1: All FHIR elements must have a @value or children |
| element |
S | 1..* | BackboneElement | Mappings for a Vendor Analyte Code from the source set ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| code |
S | 1..1 | code | Identifies the Vendor Analyte Code being mapped ele-1: All FHIR elements must have a @value or children |
| display |
S | 1..1 | string | The Vendor Analyte Name ele-1: All FHIR elements must have a @value or children |
| target |
SC | 0..* | BackboneElement | Identifies the LOINC code being mapped to cmd-1: If the map is narrower or inexact, there SHALL be some comments ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| code |
S | 1..1 | code | Code that identifies the LOINC Code ele-1: All FHIR elements must have a @value or children |
| display |
S | 1..1 | string | LOINC Long Name ele-1: All FHIR elements must have a @value or children |
| equivalence |
?!S | 1..1 | code | relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint Binding: ConceptMapEquivalence (required): The degree of equivalence between concepts. ele-1: All FHIR elements must have a @value or children |
| comment |
SC | 0..1 | string | Vendor Comment ele-1: All FHIR elements must have a @value or children |
| Slices for dependsOn |
SC | 0..4 | BackboneElement | Other elements required for this mapping (from context) Slice: Unordered, Open by value:property ele-1: All FHIR elements must have a @value or children livd-1: If the dependsOn is valued, either the code or display must be present |
| dependsOn:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| property |
1..1 | uri | Reference to property mapping depends on ele-1: All FHIR elements must have a @value or children | |
| value |
1..1 | string | Value of the referenced element ele-1: All FHIR elements must have a @value or children | |
| dependsOn:specimen |
S | 0..1 | BackboneElement | The property for specimen ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| property |
S | 1..1 | uri | Reference to property mapping depends on ele-1: All FHIR elements must have a @value or children Fixed Value: specimen |
| value |
S | 1..1 | string | Value of the specimen property ele-1: All FHIR elements must have a @value or children |
| dependsOn:result |
S | 0..1 | BackboneElement | The property for result ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| property |
S | 1..1 | uri | Reference to property mapping depends on ele-1: All FHIR elements must have a @value or children Fixed Value: result |
| value |
S | 1..1 | string | Value of the result property ele-1: All FHIR elements must have a @value or children |
| dependsOn:device |
S | 0..1 | BackboneElement | The property for device ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| property |
S | 1..1 | uri | Reference to property mapping depends on ele-1: All FHIR elements must have a @value or children Fixed Value: device |
| value |
S | 1..1 | string | Value of the device property ele-1: All FHIR elements must have a @value or children |
| dependsOn:other |
S | 0..1 | BackboneElement | The property for other ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| property |
S | 1..1 | uri | Reference to property mapping depends on ele-1: All FHIR elements must have a @value or children Fixed Value: other |
| value |
S | 1..1 | string | Value of the other value property ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ConceptMap.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | |
| ConceptMap.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | |
| ConceptMap.group.element.target.equivalence | required | ConceptMapEquivalencehttp://hl7.org/fhir/ValueSet/concept-map-equivalence|4.0.1from the FHIR Standard | |
| ConceptMap.group.unmapped.mode | required | ConceptMapGroupUnmappedModehttp://hl7.org/fhir/ValueSet/conceptmap-unmapped-mode|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cmd-0 | warning | 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}') | |
| cmd-1 | error | 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')) | |
| dom-2 | error | ConceptMap | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | 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-4 | error | 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-5 | error | ConceptMap | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ConceptMap | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| livd-1 | error | **ALL** elements | If the dependsOn is valued, either the code or display must be present : (group.element.target.dependsOn.exists() and (group.element.target.code.exists() or group.element.target.display.exists())) or group.element.target.dependsOn.empty() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ConceptMap |
C | 0..* | ConceptMap | LIVDTestCodeConceptMap cmd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation | ||||
| 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: CommonLanguages (preferred): A human language.
| |||||
| 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 |
SΣ | 0..1 | uri | Canonical identifier for this concept map, represented as a URI (globally unique) | ||||
| name |
SΣC | 1..1 | string | Name for this concept map (computer friendly) | ||||
| status |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| date |
Σ | 0..1 | dateTime | Date last changed | ||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for concept map (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| source[x] |
SΣ | 1..1 | The source value set that contains the concepts that are being mapped | |||||
| sourceUri |
uri | |||||||
| sourceCanonical |
canonical(ValueSet) | |||||||
| target[x] |
SΣ | 1..1 | The target value set which provides context for the mappings | |||||
| targetUri |
uri | |||||||
| targetCanonical |
canonical(ValueSet) | |||||||
| group |
S | 1..1 | BackboneElement | Same source and target systems | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| target |
0..1 | uri | Target system that the concepts are to be mapped to | |||||
| targetVersion |
S | 0..1 | string | Specific version of the code system | ||||
| element |
S | 1..* | BackboneElement | Mappings for a Vendor Analyte Code from the source set | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
S | 1..1 | code | Identifies the Vendor Analyte Code being mapped | ||||
| display |
S | 1..1 | string | The Vendor Analyte Name | ||||
| target |
SC | 0..* | BackboneElement | Identifies the LOINC code being mapped to cmd-1: If the map is narrower or inexact, there SHALL be some comments | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
S | 1..1 | code | Code that identifies the LOINC Code | ||||
| display |
S | 1..1 | string | LOINC Long Name | ||||
| equivalence |
?!S | 1..1 | code | relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint Binding: ConceptMapEquivalence (required): The degree of equivalence between concepts. | ||||
| comment |
SC | 0..1 | string | Vendor Comment | ||||
| Slices for dependsOn |
SC | 0..4 | BackboneElement | Other elements required for this mapping (from context) Slice: Unordered, Open by value:property | ||||
| dependsOn:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even 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:specimen |
S | 0..1 | BackboneElement | The property for specimen | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| property |
S | 1..1 | uri | Reference to property mapping depends on Fixed Value: specimen | ||||
| value |
S | 1..1 | string | Value of the specimen property | ||||
| dependsOn:result |
S | 0..1 | BackboneElement | The property for result | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| property |
S | 1..1 | uri | Reference to property mapping depends on Fixed Value: result | ||||
| value |
S | 1..1 | string | Value of the result property | ||||
| dependsOn:device |
S | 0..1 | BackboneElement | The property for device | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| property |
S | 1..1 | uri | Reference to property mapping depends on Fixed Value: device | ||||
| value |
S | 1..1 | string | Value of the device property | ||||
| dependsOn:other |
S | 0..1 | BackboneElement | The property for other | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| property |
S | 1..1 | uri | Reference to property mapping depends on Fixed Value: other | ||||
| value |
S | 1..1 | string | Value of the other value property | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| ConceptMap.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| ConceptMap.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | ||||
| ConceptMap.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | ||||
| ConceptMap.group.element.target.equivalence | required | ConceptMapEquivalencehttp://hl7.org/fhir/ValueSet/concept-map-equivalence|4.0.1from the FHIR Standard | ||||
| ConceptMap.group.unmapped.mode | required | ConceptMapGroupUnmappedModehttp://hl7.org/fhir/ValueSet/conceptmap-unmapped-mode|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cmd-0 | warning | 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}') | |
| cmd-1 | error | 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')) | |
| dom-2 | error | ConceptMap | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | 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-4 | error | 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-5 | error | ConceptMap | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ConceptMap | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| livd-1 | error | **ALL** elements | If the dependsOn is valued, either the code or display must be present : (group.element.target.dependsOn.exists() and (group.element.target.code.exists() or group.element.target.display.exists())) or group.element.target.dependsOn.empty() |
This structure is derived from ConceptMap
Summary
Mandatory: 6 elements(2 nested mandatory elements)
Must-Support: 28 elements
Fixed: 4 elements
Prohibited: 22 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 International / Orders and Observations. Package hl7.fhir.uv.livd#1.0.0-ballot based on FHIR 4.0.1. Generated 2024-12-19
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change