LOINC – IVD Test Code (LIVD) Mapping
1.0.0-ballot - ballot International flag

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

Resource Profile: LIVD Catalog

Official URL: http://hl7.org/fhir/uv/livd/StructureDefinition/catalog-uv-livd Version: 1.0.0-ballot
Active as of 2018-08-14 Computable Name: LIVDCatalog

Profile on the Composition resource to specify and organize the sections and references to the necessary resource content to express the LIVD catalog.

Description

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.

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from Composition

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..* Composition LIVDCatalog
... language S 1..1 code Publication Language
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
.... CatalogRegion S 0..* CodeableConcept LIVD Region
URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-region
... identifier S 1..1 Identifier Logical identifier of the LIVD Publication
.... use 0..0
.... type 0..0
.... system S 1..1 uri Publication Identifier Name Space
.... value S 1..1 string Publication Identifier Value
.... period 0..0
.... assigner S 1..1 Reference(Organization) Organization that issued id (may be just text)
..... reference 0..0
..... identifier 0..0
..... display S 1..1 string Publication Vendor Name
... type S 1..1 CodeableConcept Kind of composition (LOINC if possible)
.... coding S 1..1 Coding Code defined by a terminology system
..... system S 1..1 uri LOINC Coding System
..... version S 1..1 string LOINC Code Version
..... code S 1..1 code LIVD Mapping Publication LOINC Code
..... display S 1..1 string Representation defined by the system
..... userSelected 0..0
.... text 0..0
... category 0..0
... subject 0..0
... encounter 0..0
... date S 1..1 dateTime Composition editing time
... author S 1..1 Reference(Organization) Who and/or what authored the composition
.... reference 0..0
.... identifier 0..0
.... display S 1..1 string Vendor Name
... title S 1..1 string LIVD Mapping Publication Title
... confidentiality 0..0
... attester 0..0
... custodian 0..0
... relatesTo 0..0
... event 0..0
... section S 1..* BackboneElement Composition is broken into sections
.... title S 1..1 string Label for section (e.g. for Devices)
.... code S 1..1 CodeableConcept devices | concept-map | loinc-codes | ivd-test-codes | entry-definitions
Binding: Types of sections for the LIVD catalog (required): The type of sections used in the LIVD Mapping Publication

.... text 0..0
.... mode 0..0
.... orderedBy 0..0
.... entry S 1..* Reference(Resource) A reference to data that supports this section
..... reference S 1..1 string Literal reference, Relative, internal or absolute URL
..... identifier 0..0
..... display 0..0
.... emptyReason 0..0
.... section 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Composition.section.coderequiredLivdSectionTypeVS (a valid code from Types of sections for the LIVD catalog)
http://hl7.org/fhir/uv/livd/ValueSet/livd-section-type
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..* Composition LIVDCatalog
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
... language S 1..1 code Publication Language
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding

ele-1: All FHIR elements must have a @value or children
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... CatalogRegion S 0..* CodeableConcept LIVD Region
URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-region
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier SΣ 1..1 Identifier Logical identifier of the LIVD Publication
ele-1: All FHIR elements must have a @value or children
.... system SΣ 1..1 uri Publication Identifier Name Space
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string Publication Identifier Value
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... assigner SΣ 1..1 Reference(Organization) Organization that issued id (may be just text)
ele-1: All FHIR elements must have a @value or children
..... display SΣ 1..1 string Publication Vendor Name
ele-1: All FHIR elements must have a @value or children
... status ?!SΣ 1..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.


ele-1: All FHIR elements must have a @value or children
... type SΣ 1..1 CodeableConcept Kind of composition (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.


ele-1: All FHIR elements must have a @value or children
.... coding SΣ 1..1 Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
..... system SΣ 1..1 uri LOINC Coding System
ele-1: All FHIR elements must have a @value or children
..... version SΣ 1..1 string LOINC Code Version
ele-1: All FHIR elements must have a @value or children
..... code SΣ 1..1 code LIVD Mapping Publication LOINC Code
ele-1: All FHIR elements must have a @value or children
..... display SΣ 1..1 string Representation defined by the system
ele-1: All FHIR elements must have a @value or children
... date SΣ 1..1 dateTime Composition editing time
ele-1: All FHIR elements must have a @value or children
... author SΣ 1..1 Reference(Organization) Who and/or what authored the composition
ele-1: All FHIR elements must have a @value or children
.... display SΣ 1..1 string Vendor Name
ele-1: All FHIR elements must have a @value or children
... title SΣ 1..1 string LIVD Mapping Publication Title
ele-1: All FHIR elements must have a @value or children
... section SC 1..* BackboneElement Composition is broken into sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
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
.... title S 1..1 string Label for section (e.g. for Devices)
ele-1: All FHIR elements must have a @value or children
.... code S 1..1 CodeableConcept devices | concept-map | loinc-codes | ivd-test-codes | entry-definitions
Binding: Types of sections for the LIVD catalog (required): The type of sections used in the LIVD Mapping Publication


ele-1: All FHIR elements must have a @value or children
.... entry SC 1..* Reference(Resource) A reference to data that supports this section
ele-1: All FHIR elements must have a @value or children
..... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Composition.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Composition.statusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
Composition.typepreferredFHIRDocumentTypeCodes
http://hl7.org/fhir/ValueSet/doc-typecodes
from the FHIR Standard
Composition.attester.moderequiredCompositionAttestationMode
http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1
from the FHIR Standard
Composition.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
Composition.event.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Composition.section.coderequiredLivdSectionTypeVS (a valid code from Types of sections for the LIVD catalog)
http://hl7.org/fhir/uv/livd/ValueSet/livd-section-type
from this IG

Constraints

IdGradePath(s)DetailsRequirements
cmp-1errorComposition.sectionA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2errorComposition.sectionA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
dom-2errorCompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCompositionIf 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-4errorCompositionIf 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-5errorCompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCompositionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..* Composition LIVDCatalog
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
.... CatalogRegion S 0..* CodeableConcept LIVD Region
URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-region
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..1 Identifier Logical identifier of the LIVD Publication
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣ 1..1 uri Publication Identifier Name Space
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string Publication Identifier Value
Example General: 123456
.... assigner SΣ 1..1 Reference(Organization) Organization that issued id (may be just text)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ 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).

..... display SΣ 1..1 string Publication Vendor Name
... status ?!SΣ 1..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.

... type SΣ 1..1 CodeableConcept Kind of composition (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 1..1 Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ 1..1 uri LOINC Coding System
..... version SΣ 1..1 string LOINC Code Version
..... code SΣ 1..1 code LIVD Mapping Publication LOINC Code
..... display SΣ 1..1 string Representation defined by the system
... date SΣ 1..1 dateTime Composition editing time
... author SΣ 1..1 Reference(Organization) Who and/or what authored the composition
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ 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).

.... display SΣ 1..1 string Vendor Name
... title SΣ 1..1 string LIVD Mapping Publication Title
... section SC 1..* BackboneElement Composition is broken into sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
.... 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
.... title S 1..1 string Label for section (e.g. for Devices)
.... code S 1..1 CodeableConcept devices | concept-map | loinc-codes | ivd-test-codes | entry-definitions
Binding: Types of sections for the LIVD catalog (required): The type of sections used in the LIVD Mapping Publication

.... author 0..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section
.... focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
.... entry SC 1..* Reference(Resource) A reference to data that supports this section
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 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).


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Composition.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Composition.identifier.assigner.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Composition.statusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
Composition.typepreferredFHIRDocumentTypeCodes
http://hl7.org/fhir/ValueSet/doc-typecodes
from the FHIR Standard
Composition.author.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Composition.attester.moderequiredCompositionAttestationMode
http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1
from the FHIR Standard
Composition.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
Composition.event.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Composition.section.coderequiredLivdSectionTypeVS (a valid code from Types of sections for the LIVD catalog)
http://hl7.org/fhir/uv/livd/ValueSet/livd-section-type
from this IG
Composition.section.entry.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmp-1errorComposition.sectionA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2errorComposition.sectionA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
dom-2errorCompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCompositionIf 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-4errorCompositionIf 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-5errorCompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCompositionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Composition

Summary

Mandatory: 17 elements
Must-Support: 24 elements
Prohibited: 24 elements

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from Composition

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..* Composition LIVDCatalog
... language S 1..1 code Publication Language
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
.... CatalogRegion S 0..* CodeableConcept LIVD Region
URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-region
... identifier S 1..1 Identifier Logical identifier of the LIVD Publication
.... use 0..0
.... type 0..0
.... system S 1..1 uri Publication Identifier Name Space
.... value S 1..1 string Publication Identifier Value
.... period 0..0
.... assigner S 1..1 Reference(Organization) Organization that issued id (may be just text)
..... reference 0..0
..... identifier 0..0
..... display S 1..1 string Publication Vendor Name
... type S 1..1 CodeableConcept Kind of composition (LOINC if possible)
.... coding S 1..1 Coding Code defined by a terminology system
..... system S 1..1 uri LOINC Coding System
..... version S 1..1 string LOINC Code Version
..... code S 1..1 code LIVD Mapping Publication LOINC Code
..... display S 1..1 string Representation defined by the system
..... userSelected 0..0
.... text 0..0
... category 0..0
... subject 0..0
... encounter 0..0
... date S 1..1 dateTime Composition editing time
... author S 1..1 Reference(Organization) Who and/or what authored the composition
.... reference 0..0
.... identifier 0..0
.... display S 1..1 string Vendor Name
... title S 1..1 string LIVD Mapping Publication Title
... confidentiality 0..0
... attester 0..0
... custodian 0..0
... relatesTo 0..0
... event 0..0
... section S 1..* BackboneElement Composition is broken into sections
.... title S 1..1 string Label for section (e.g. for Devices)
.... code S 1..1 CodeableConcept devices | concept-map | loinc-codes | ivd-test-codes | entry-definitions
Binding: Types of sections for the LIVD catalog (required): The type of sections used in the LIVD Mapping Publication

.... text 0..0
.... mode 0..0
.... orderedBy 0..0
.... entry S 1..* Reference(Resource) A reference to data that supports this section
..... reference S 1..1 string Literal reference, Relative, internal or absolute URL
..... identifier 0..0
..... display 0..0
.... emptyReason 0..0
.... section 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Composition.section.coderequiredLivdSectionTypeVS (a valid code from Types of sections for the LIVD catalog)
http://hl7.org/fhir/uv/livd/ValueSet/livd-section-type
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..* Composition LIVDCatalog
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
... language S 1..1 code Publication Language
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding

ele-1: All FHIR elements must have a @value or children
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... CatalogRegion S 0..* CodeableConcept LIVD Region
URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-region
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier SΣ 1..1 Identifier Logical identifier of the LIVD Publication
ele-1: All FHIR elements must have a @value or children
.... system SΣ 1..1 uri Publication Identifier Name Space
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string Publication Identifier Value
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... assigner SΣ 1..1 Reference(Organization) Organization that issued id (may be just text)
ele-1: All FHIR elements must have a @value or children
..... display SΣ 1..1 string Publication Vendor Name
ele-1: All FHIR elements must have a @value or children
... status ?!SΣ 1..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.


ele-1: All FHIR elements must have a @value or children
... type SΣ 1..1 CodeableConcept Kind of composition (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.


ele-1: All FHIR elements must have a @value or children
.... coding SΣ 1..1 Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
..... system SΣ 1..1 uri LOINC Coding System
ele-1: All FHIR elements must have a @value or children
..... version SΣ 1..1 string LOINC Code Version
ele-1: All FHIR elements must have a @value or children
..... code SΣ 1..1 code LIVD Mapping Publication LOINC Code
ele-1: All FHIR elements must have a @value or children
..... display SΣ 1..1 string Representation defined by the system
ele-1: All FHIR elements must have a @value or children
... date SΣ 1..1 dateTime Composition editing time
ele-1: All FHIR elements must have a @value or children
... author SΣ 1..1 Reference(Organization) Who and/or what authored the composition
ele-1: All FHIR elements must have a @value or children
.... display SΣ 1..1 string Vendor Name
ele-1: All FHIR elements must have a @value or children
... title SΣ 1..1 string LIVD Mapping Publication Title
ele-1: All FHIR elements must have a @value or children
... section SC 1..* BackboneElement Composition is broken into sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
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
.... title S 1..1 string Label for section (e.g. for Devices)
ele-1: All FHIR elements must have a @value or children
.... code S 1..1 CodeableConcept devices | concept-map | loinc-codes | ivd-test-codes | entry-definitions
Binding: Types of sections for the LIVD catalog (required): The type of sections used in the LIVD Mapping Publication


ele-1: All FHIR elements must have a @value or children
.... entry SC 1..* Reference(Resource) A reference to data that supports this section
ele-1: All FHIR elements must have a @value or children
..... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Composition.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Composition.statusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
Composition.typepreferredFHIRDocumentTypeCodes
http://hl7.org/fhir/ValueSet/doc-typecodes
from the FHIR Standard
Composition.attester.moderequiredCompositionAttestationMode
http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1
from the FHIR Standard
Composition.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
Composition.event.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Composition.section.coderequiredLivdSectionTypeVS (a valid code from Types of sections for the LIVD catalog)
http://hl7.org/fhir/uv/livd/ValueSet/livd-section-type
from this IG

Constraints

IdGradePath(s)DetailsRequirements
cmp-1errorComposition.sectionA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2errorComposition.sectionA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
dom-2errorCompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCompositionIf 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-4errorCompositionIf 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-5errorCompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCompositionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..* Composition LIVDCatalog
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
.... CatalogRegion S 0..* CodeableConcept LIVD Region
URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-region
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..1 Identifier Logical identifier of the LIVD Publication
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣ 1..1 uri Publication Identifier Name Space
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string Publication Identifier Value
Example General: 123456
.... assigner SΣ 1..1 Reference(Organization) Organization that issued id (may be just text)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ 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).

..... display SΣ 1..1 string Publication Vendor Name
... status ?!SΣ 1..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.

... type SΣ 1..1 CodeableConcept Kind of composition (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 1..1 Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ 1..1 uri LOINC Coding System
..... version SΣ 1..1 string LOINC Code Version
..... code SΣ 1..1 code LIVD Mapping Publication LOINC Code
..... display SΣ 1..1 string Representation defined by the system
... date SΣ 1..1 dateTime Composition editing time
... author SΣ 1..1 Reference(Organization) Who and/or what authored the composition
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ 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).

.... display SΣ 1..1 string Vendor Name
... title SΣ 1..1 string LIVD Mapping Publication Title
... section SC 1..* BackboneElement Composition is broken into sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
.... 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
.... title S 1..1 string Label for section (e.g. for Devices)
.... code S 1..1 CodeableConcept devices | concept-map | loinc-codes | ivd-test-codes | entry-definitions
Binding: Types of sections for the LIVD catalog (required): The type of sections used in the LIVD Mapping Publication

.... author 0..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section
.... focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
.... entry SC 1..* Reference(Resource) A reference to data that supports this section
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 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).


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Composition.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Composition.identifier.assigner.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Composition.statusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
Composition.typepreferredFHIRDocumentTypeCodes
http://hl7.org/fhir/ValueSet/doc-typecodes
from the FHIR Standard
Composition.author.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Composition.attester.moderequiredCompositionAttestationMode
http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1
from the FHIR Standard
Composition.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
Composition.event.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Composition.section.coderequiredLivdSectionTypeVS (a valid code from Types of sections for the LIVD catalog)
http://hl7.org/fhir/uv/livd/ValueSet/livd-section-type
from this IG
Composition.section.entry.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmp-1errorComposition.sectionA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2errorComposition.sectionA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
dom-2errorCompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCompositionIf 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-4errorCompositionIf 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-5errorCompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCompositionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Composition

Summary

Mandatory: 17 elements
Must-Support: 24 elements
Prohibited: 24 elements

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron