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 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/catalog-uv-livd | Version: 1.0.0 | |||
| Standards status: Trial-use Active as of 2018-08-14 | Maturity Level: 2 | Computable Name: LIVDCatalog | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.51.42.2 | ||||
Profile on the Composition resource to specify and organize the sections and references to the necessary resource content to express the LIVD catalog.
The LIVD Catalog is a profile on the Composition resource to specify and organize the sections and references to the necessary resource content to express the LIVD catalog.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Composition | LIVDCatalog | |||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
S | 1..1 | code | Publication Language Binding: CommonLanguages (preferred): A human language.
| ||||
![]() ![]() |
S | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() |
S | 0..* | CodeableConcept | LIVD Region URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-region | ||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 1..1 | Identifier | Logical identifier of the LIVD Publication | ||||
![]() ![]() ![]() |
SΣ | 1..1 | uri | Publication Identifier Name Space Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Publication Identifier Value Example General: 123456 | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Publication Vendor Name | ||||
![]() ![]() |
?!SΣ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. | ||||
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | LOINC Coding System | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | LOINC Code Version | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | LIVD Mapping Publication LOINC Code | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Representation defined by the system | ||||
![]() ![]() |
SΣ | 1..1 | dateTime | Composition editing time | ||||
![]() ![]() |
SΣ | 1..1 | Reference(Organization) | Who and/or what authored the composition | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Vendor Name | ||||
![]() ![]() |
SΣ | 1..1 | string | LIVD Mapping Publication Title | ||||
![]() ![]() |
SC | 1..* | BackboneElement | Composition is broken into sections Constraints: cmp-1, cmp-2 | ||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
S | 1..1 | string | Label for section (e.g. for Devices) | ||||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | devices | concept-map | loinc-codes | ivd-test-codes | entry-definitions Binding: Types of sections for the LIVD catalog VS (required): The type of sections used in the LIVD Mapping Publication | ||||
![]() ![]() ![]() |
SC | 1..* | Reference(Resource) | A reference to data that supports this section | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Composition.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Composition.status | Base | required | CompositionStatus | 📍4.0.1 | FHIR Std. |
| Composition.type | Base | preferred | FHIR Document Type Codes | 📍4.0.1 | FHIR Std. |
| Composition.attester.mode | Base | required | CompositionAttestationMode | 📍4.0.1 | FHIR Std. |
| Composition.relatesTo.code | Base | required | DocumentRelationshipType | 📍4.0.1 | FHIR Std. |
| Composition.event.code | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v7.0 |
| Composition.section.code | Base | required | Types of sections for the LIVD catalog VS | 📦1.0.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| cmp-1 | error | Composition.section | A section must contain at least one of text, entries, or sub-sections |
text.exists() or entry.exists() or section.exists()
|
| cmp-2 | error | Composition.section | A section can only have an emptyReason if it is empty |
emptyReason.empty() or entry.empty()
|
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Composition | 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 | Composition | 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 | Composition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Composition | 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()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Composition | LIVDCatalog | |
![]() ![]() |
S | 1..1 | code | Publication Language |
![]() ![]() |
S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | LIVD Region URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-region |
![]() ![]() |
S | 1..1 | Identifier | Logical identifier of the LIVD Publication |
![]() ![]() ![]() |
0..0 | usual | official | temp | secondary | old (If known) | ||
![]() ![]() ![]() |
0..0 | Description of identifier | ||
![]() ![]() ![]() |
S | 1..1 | uri | Publication Identifier Name Space |
![]() ![]() ![]() |
S | 1..1 | string | Publication Identifier Value |
![]() ![]() ![]() |
0..0 | Time period when id is/was valid for use | ||
![]() ![]() ![]() |
S | 1..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() ![]() |
0..0 | Literal reference, Relative, internal or absolute URL | ||
![]() ![]() ![]() ![]() |
0..0 | Logical reference, when literal reference is not known | ||
![]() ![]() ![]() ![]() |
S | 1..1 | string | Publication Vendor Name |
![]() ![]() |
S | 1..1 | code | preliminary | final | amended | entered-in-error |
![]() ![]() |
S | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) |
![]() ![]() ![]() |
S | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
S | 1..1 | uri | LOINC Coding System |
![]() ![]() ![]() ![]() |
S | 1..1 | string | LOINC Code Version |
![]() ![]() ![]() ![]() |
S | 1..1 | code | LIVD Mapping Publication LOINC Code |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() |
0..0 | If this coding was chosen directly by the user | ||
![]() ![]() ![]() |
0..0 | Plain text representation of the concept | ||
![]() ![]() |
0..0 | Categorization of Composition | ||
![]() ![]() |
0..0 | Who and/or what the composition is about | ||
![]() ![]() |
0..0 | Context of the Composition | ||
![]() ![]() |
S | 1..1 | dateTime | Composition editing time |
![]() ![]() |
S | 1..1 | Reference(Organization) | Who and/or what authored the composition |
![]() ![]() ![]() |
0..0 | Literal reference, Relative, internal or absolute URL | ||
![]() ![]() ![]() |
0..0 | Logical reference, when literal reference is not known | ||
![]() ![]() ![]() |
S | 1..1 | string | Vendor Name |
![]() ![]() |
S | 1..1 | string | LIVD Mapping Publication Title |
![]() ![]() |
0..0 | As defined by affinity domain | ||
![]() ![]() |
0..0 | Attests to accuracy of composition | ||
![]() ![]() |
0..0 | Organization which maintains the composition | ||
![]() ![]() |
0..0 | Relationships to other compositions/documents | ||
![]() ![]() |
0..0 | The clinical service(s) being documented | ||
![]() ![]() |
S | 1..* | BackboneElement | Composition is broken into sections |
![]() ![]() ![]() |
S | 1..1 | string | Label for section (e.g. for Devices) |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | devices | concept-map | loinc-codes | ivd-test-codes | entry-definitions Binding: Types of sections for the LIVD catalog VS (required): The type of sections used in the LIVD Mapping Publication |
![]() ![]() ![]() |
0..0 | Text summary of the section, for human interpretation | ||
![]() ![]() ![]() |
0..0 | working | snapshot | changes | ||
![]() ![]() ![]() |
0..0 | Order of section entries | ||
![]() ![]() ![]() |
S | 1..* | Reference(Resource) | A reference to data that supports this section |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() |
0..0 | Logical reference, when literal reference is not known | ||
![]() ![]() ![]() ![]() |
0..0 | Text alternative for the resource | ||
![]() ![]() ![]() |
0..0 | Why the section is empty | ||
![]() ![]() ![]() |
0..0 | Nested Section | ||
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Composition.section.code | Base | required | Types of sections for the LIVD catalog VS | 📦1.0.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Composition | LIVDCatalog | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
S | 1..1 | code | Publication Language Binding: CommonLanguages (preferred): A human language.
| ||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
S | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() |
S | 0..* | CodeableConcept | LIVD Region URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-region | ||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 1..1 | Identifier | Logical identifier of the LIVD Publication | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣ | 1..1 | uri | Publication Identifier Name Space Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Publication Identifier Value Example General: 123456 | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Publication Vendor Name | ||||
![]() ![]() |
?!SΣ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. | ||||
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | LOINC Coding System | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | LOINC Code Version | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | LIVD Mapping Publication LOINC Code | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Representation defined by the system | ||||
![]() ![]() |
SΣ | 1..1 | dateTime | Composition editing time | ||||
![]() ![]() |
SΣ | 1..1 | Reference(Organization) | Who and/or what authored the composition | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Vendor Name | ||||
![]() ![]() |
SΣ | 1..1 | string | LIVD Mapping Publication Title | ||||
![]() ![]() |
SC | 1..* | BackboneElement | Composition is broken into sections Constraints: cmp-1, cmp-2 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
S | 1..1 | string | Label for section (e.g. for Devices) | ||||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | devices | concept-map | loinc-codes | ivd-test-codes | entry-definitions Binding: Types of sections for the LIVD catalog VS (required): The type of sections used in the LIVD Mapping Publication | ||||
![]() ![]() ![]() |
0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section | |||||
![]() ![]() ![]() |
0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
![]() ![]() ![]() |
SC | 1..* | Reference(Resource) | A reference to data that supports this section | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Composition.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Composition.identifier.assigner.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Composition.status | Base | required | CompositionStatus | 📍4.0.1 | FHIR Std. |
| Composition.type | Base | preferred | FHIR Document Type Codes | 📍4.0.1 | FHIR Std. |
| Composition.author.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Composition.attester.mode | Base | required | CompositionAttestationMode | 📍4.0.1 | FHIR Std. |
| Composition.relatesTo.code | Base | required | DocumentRelationshipType | 📍4.0.1 | FHIR Std. |
| Composition.event.code | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v7.0 |
| Composition.section.code | Base | required | Types of sections for the LIVD catalog VS | 📦1.0.0 | This IG |
| Composition.section.entry.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cmp-1 | error | Composition.section | A section must contain at least one of text, entries, or sub-sections |
text.exists() or entry.exists() or section.exists()
|
| cmp-2 | error | Composition.section | A section can only have an emptyReason if it is empty |
emptyReason.empty() or entry.empty()
|
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Composition | 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 | Composition | 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 | Composition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Composition | 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()
|
Summary
Mandatory: 17 elements
Must-Support: 24 elements
Prohibited: 24 elements
Extensions
This structure refers to these extensions:
Maturity: 2
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Composition | LIVDCatalog | |||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
S | 1..1 | code | Publication Language Binding: CommonLanguages (preferred): A human language.
| ||||
![]() ![]() |
S | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() |
S | 0..* | CodeableConcept | LIVD Region URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-region | ||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 1..1 | Identifier | Logical identifier of the LIVD Publication | ||||
![]() ![]() ![]() |
SΣ | 1..1 | uri | Publication Identifier Name Space Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Publication Identifier Value Example General: 123456 | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Publication Vendor Name | ||||
![]() ![]() |
?!SΣ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. | ||||
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | LOINC Coding System | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | LOINC Code Version | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | LIVD Mapping Publication LOINC Code | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Representation defined by the system | ||||
![]() ![]() |
SΣ | 1..1 | dateTime | Composition editing time | ||||
![]() ![]() |
SΣ | 1..1 | Reference(Organization) | Who and/or what authored the composition | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Vendor Name | ||||
![]() ![]() |
SΣ | 1..1 | string | LIVD Mapping Publication Title | ||||
![]() ![]() |
SC | 1..* | BackboneElement | Composition is broken into sections Constraints: cmp-1, cmp-2 | ||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
S | 1..1 | string | Label for section (e.g. for Devices) | ||||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | devices | concept-map | loinc-codes | ivd-test-codes | entry-definitions Binding: Types of sections for the LIVD catalog VS (required): The type of sections used in the LIVD Mapping Publication | ||||
![]() ![]() ![]() |
SC | 1..* | Reference(Resource) | A reference to data that supports this section | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Composition.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Composition.status | Base | required | CompositionStatus | 📍4.0.1 | FHIR Std. |
| Composition.type | Base | preferred | FHIR Document Type Codes | 📍4.0.1 | FHIR Std. |
| Composition.attester.mode | Base | required | CompositionAttestationMode | 📍4.0.1 | FHIR Std. |
| Composition.relatesTo.code | Base | required | DocumentRelationshipType | 📍4.0.1 | FHIR Std. |
| Composition.event.code | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v7.0 |
| Composition.section.code | Base | required | Types of sections for the LIVD catalog VS | 📦1.0.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| cmp-1 | error | Composition.section | A section must contain at least one of text, entries, or sub-sections |
text.exists() or entry.exists() or section.exists()
|
| cmp-2 | error | Composition.section | A section can only have an emptyReason if it is empty |
emptyReason.empty() or entry.empty()
|
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Composition | 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 | Composition | 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 | Composition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Composition | 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()
|
Differential View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Composition | LIVDCatalog | |
![]() ![]() |
S | 1..1 | code | Publication Language |
![]() ![]() |
S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | LIVD Region URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-region |
![]() ![]() |
S | 1..1 | Identifier | Logical identifier of the LIVD Publication |
![]() ![]() ![]() |
0..0 | usual | official | temp | secondary | old (If known) | ||
![]() ![]() ![]() |
0..0 | Description of identifier | ||
![]() ![]() ![]() |
S | 1..1 | uri | Publication Identifier Name Space |
![]() ![]() ![]() |
S | 1..1 | string | Publication Identifier Value |
![]() ![]() ![]() |
0..0 | Time period when id is/was valid for use | ||
![]() ![]() ![]() |
S | 1..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() ![]() |
0..0 | Literal reference, Relative, internal or absolute URL | ||
![]() ![]() ![]() ![]() |
0..0 | Logical reference, when literal reference is not known | ||
![]() ![]() ![]() ![]() |
S | 1..1 | string | Publication Vendor Name |
![]() ![]() |
S | 1..1 | code | preliminary | final | amended | entered-in-error |
![]() ![]() |
S | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) |
![]() ![]() ![]() |
S | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
S | 1..1 | uri | LOINC Coding System |
![]() ![]() ![]() ![]() |
S | 1..1 | string | LOINC Code Version |
![]() ![]() ![]() ![]() |
S | 1..1 | code | LIVD Mapping Publication LOINC Code |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() |
0..0 | If this coding was chosen directly by the user | ||
![]() ![]() ![]() |
0..0 | Plain text representation of the concept | ||
![]() ![]() |
0..0 | Categorization of Composition | ||
![]() ![]() |
0..0 | Who and/or what the composition is about | ||
![]() ![]() |
0..0 | Context of the Composition | ||
![]() ![]() |
S | 1..1 | dateTime | Composition editing time |
![]() ![]() |
S | 1..1 | Reference(Organization) | Who and/or what authored the composition |
![]() ![]() ![]() |
0..0 | Literal reference, Relative, internal or absolute URL | ||
![]() ![]() ![]() |
0..0 | Logical reference, when literal reference is not known | ||
![]() ![]() ![]() |
S | 1..1 | string | Vendor Name |
![]() ![]() |
S | 1..1 | string | LIVD Mapping Publication Title |
![]() ![]() |
0..0 | As defined by affinity domain | ||
![]() ![]() |
0..0 | Attests to accuracy of composition | ||
![]() ![]() |
0..0 | Organization which maintains the composition | ||
![]() ![]() |
0..0 | Relationships to other compositions/documents | ||
![]() ![]() |
0..0 | The clinical service(s) being documented | ||
![]() ![]() |
S | 1..* | BackboneElement | Composition is broken into sections |
![]() ![]() ![]() |
S | 1..1 | string | Label for section (e.g. for Devices) |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | devices | concept-map | loinc-codes | ivd-test-codes | entry-definitions Binding: Types of sections for the LIVD catalog VS (required): The type of sections used in the LIVD Mapping Publication |
![]() ![]() ![]() |
0..0 | Text summary of the section, for human interpretation | ||
![]() ![]() ![]() |
0..0 | working | snapshot | changes | ||
![]() ![]() ![]() |
0..0 | Order of section entries | ||
![]() ![]() ![]() |
S | 1..* | Reference(Resource) | A reference to data that supports this section |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() |
0..0 | Logical reference, when literal reference is not known | ||
![]() ![]() ![]() ![]() |
0..0 | Text alternative for the resource | ||
![]() ![]() ![]() |
0..0 | Why the section is empty | ||
![]() ![]() ![]() |
0..0 | Nested Section | ||
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Composition.section.code | Base | required | Types of sections for the LIVD catalog VS | 📦1.0.0 | This IG |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Composition | LIVDCatalog | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
S | 1..1 | code | Publication Language Binding: CommonLanguages (preferred): A human language.
| ||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
S | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() |
S | 0..* | CodeableConcept | LIVD Region URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-region | ||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 1..1 | Identifier | Logical identifier of the LIVD Publication | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣ | 1..1 | uri | Publication Identifier Name Space Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Publication Identifier Value Example General: 123456 | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Publication Vendor Name | ||||
![]() ![]() |
?!SΣ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. | ||||
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | LOINC Coding System | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | LOINC Code Version | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | LIVD Mapping Publication LOINC Code | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Representation defined by the system | ||||
![]() ![]() |
SΣ | 1..1 | dateTime | Composition editing time | ||||
![]() ![]() |
SΣ | 1..1 | Reference(Organization) | Who and/or what authored the composition | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Vendor Name | ||||
![]() ![]() |
SΣ | 1..1 | string | LIVD Mapping Publication Title | ||||
![]() ![]() |
SC | 1..* | BackboneElement | Composition is broken into sections Constraints: cmp-1, cmp-2 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
S | 1..1 | string | Label for section (e.g. for Devices) | ||||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | devices | concept-map | loinc-codes | ivd-test-codes | entry-definitions Binding: Types of sections for the LIVD catalog VS (required): The type of sections used in the LIVD Mapping Publication | ||||
![]() ![]() ![]() |
0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section | |||||
![]() ![]() ![]() |
0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
![]() ![]() ![]() |
SC | 1..* | Reference(Resource) | A reference to data that supports this section | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Composition.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Composition.identifier.assigner.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Composition.status | Base | required | CompositionStatus | 📍4.0.1 | FHIR Std. |
| Composition.type | Base | preferred | FHIR Document Type Codes | 📍4.0.1 | FHIR Std. |
| Composition.author.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Composition.attester.mode | Base | required | CompositionAttestationMode | 📍4.0.1 | FHIR Std. |
| Composition.relatesTo.code | Base | required | DocumentRelationshipType | 📍4.0.1 | FHIR Std. |
| Composition.event.code | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v7.0 |
| Composition.section.code | Base | required | Types of sections for the LIVD catalog VS | 📦1.0.0 | This IG |
| Composition.section.entry.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cmp-1 | error | Composition.section | A section must contain at least one of text, entries, or sub-sections |
text.exists() or entry.exists() or section.exists()
|
| cmp-2 | error | Composition.section | A section can only have an emptyReason if it is empty |
emptyReason.empty() or entry.empty()
|
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Composition | 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 | Composition | 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 | Composition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Composition | 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()
|
Summary
Mandatory: 17 elements
Must-Support: 24 elements
Prohibited: 24 elements
Extensions
This structure refers to these extensions:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron