This page is part of the Loinc/IVD Mapping FHIR IG (v0.1.0: STU 1 Draft) based on FHIR (HL7® FHIR® Standard) v3.5.0. No current official version has been published yet. For a full list of available versions, see the Directory of published versions

This is a pre-release version (Draft for Comment) of Loinc/IVD Mapping (LIVD) R1 (STU). There is no current official version.
For a full list of available versions, see the Directory of published versions .

StructureDefinition: LIVD Catalog

The official URL for this profile is: 

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

Formal Views of Profile Content

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

This structure is derived from Composition

Summary

Mandatory: 22 elements (3 nested mandatory elements)
Prohibited: 24 elements

This structure is derived from Composition

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*LIVD Catalog
... language 1..1codePublication Language
... identifier 1..1IdentifierLogical identifier of the LIVD Publication
.... use 0..0
.... type 0..0
.... system 1..1uriPublication Identifier Name Space
.... value 1..1stringPublication Identifier Value
.... period 0..0
.... assigner 1..1Reference(Organization)
..... reference 0..0
..... identifier 0..0
..... display 1..1stringPublication Vendor Name
... status 1..1codepreliminary | final | amended | entered-in-error
... type 1..1CodeableConceptKind of composition (LOINC if possible)
.... coding 1..1Coding
..... system 1..1uriLOINC Coding System
..... version 1..1stringLOINC Code Version
..... code 1..1codeLIVD Mappipng Publication LOINC Code
..... display 1..1string
..... userSelected 0..0
.... text 0..0
... category 0..0
... subject 0..0
... encounter 0..0
... date 1..1dateTimeComposition editing time
... author 1..1Reference(Organization)Who and/or what authored the composition
.... reference 0..0
.... identifier 0..0
.... display 1..1stringVendor Name
... title 1..1stringLIVD Mapping Publication Title
... confidentiality 0..0
... attester 0..0
... custodian 0..0
... relatesTo 0..0
... event 0..0
... section 1..*BackboneElementComposition is broken into sections
.... title 1..1stringLabel for section (e.g. for Devices)
.... code 1..1CodeableConceptdevices | concept-map | loinc-codes | ivd-test-codes | entry-definitions
Binding: LIVDSectionType (required)
.... text 0..0
.... mode 0..0
.... orderedBy 0..0
.... entry 1..*Reference(Resource)A reference to data that supports this section
..... reference 1..1string
..... identifier 0..0
..... display 0..0
.... emptyReason 0..0
.... section 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition I0..*LIVD Catalog
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 1..1codePublication Language
Binding: Common Languages (preferred)
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..1IdentifierLogical identifier of the LIVD Publication
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system Σ1..1uriPublication Identifier Name Space
Example General': http://www.acme.com/identifiers/patient
.... value Σ1..1stringPublication Identifier Value
Example General': 123456
.... assigner Σ1..1Reference(Organization)Organization that issued id (may be just text)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
..... display Σ1..1stringPublication Vendor Name
... status ?!Σ1..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required)
... type Σ1..1CodeableConceptKind of composition (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ1..1CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriLOINC Coding System
..... version Σ1..1stringLOINC Code Version
..... code Σ1..1codeLIVD Mappipng Publication LOINC Code
..... display Σ1..1stringRepresentation defined by the system
... date Σ1..1dateTimeComposition editing time
... author Σ1..1Reference(Organization)Who and/or what authored the composition
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... display Σ1..1stringVendor Name
... title Σ1..1stringLIVD Mapping Publication Title
... section I1..*BackboneElementComposition is broken into sections
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... title 1..1stringLabel for section (e.g. for Devices)
.... code 1..1CodeableConceptdevices | concept-map | loinc-codes | ivd-test-codes | entry-definitions
Binding: LIVDSectionType (required)
.... author 0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the section
.... entry I1..*Reference(Resource)A reference to data that supports this section
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣI1..1stringLiteral reference, Relative, internal or absolute URL
..... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)

doco Documentation for this format

This structure is derived from Composition

Summary

Mandatory: 22 elements (3 nested mandatory elements)
Prohibited: 24 elements

Differential View

This structure is derived from Composition

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*LIVD Catalog
... language 1..1codePublication Language
... identifier 1..1IdentifierLogical identifier of the LIVD Publication
.... use 0..0
.... type 0..0
.... system 1..1uriPublication Identifier Name Space
.... value 1..1stringPublication Identifier Value
.... period 0..0
.... assigner 1..1Reference(Organization)
..... reference 0..0
..... identifier 0..0
..... display 1..1stringPublication Vendor Name
... status 1..1codepreliminary | final | amended | entered-in-error
... type 1..1CodeableConceptKind of composition (LOINC if possible)
.... coding 1..1Coding
..... system 1..1uriLOINC Coding System
..... version 1..1stringLOINC Code Version
..... code 1..1codeLIVD Mappipng Publication LOINC Code
..... display 1..1string
..... userSelected 0..0
.... text 0..0
... category 0..0
... subject 0..0
... encounter 0..0
... date 1..1dateTimeComposition editing time
... author 1..1Reference(Organization)Who and/or what authored the composition
.... reference 0..0
.... identifier 0..0
.... display 1..1stringVendor Name
... title 1..1stringLIVD Mapping Publication Title
... confidentiality 0..0
... attester 0..0
... custodian 0..0
... relatesTo 0..0
... event 0..0
... section 1..*BackboneElementComposition is broken into sections
.... title 1..1stringLabel for section (e.g. for Devices)
.... code 1..1CodeableConceptdevices | concept-map | loinc-codes | ivd-test-codes | entry-definitions
Binding: LIVDSectionType (required)
.... text 0..0
.... mode 0..0
.... orderedBy 0..0
.... entry 1..*Reference(Resource)A reference to data that supports this section
..... reference 1..1string
..... identifier 0..0
..... display 0..0
.... emptyReason 0..0
.... section 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition I0..*LIVD Catalog
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 1..1codePublication Language
Binding: Common Languages (preferred)
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..1IdentifierLogical identifier of the LIVD Publication
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system Σ1..1uriPublication Identifier Name Space
Example General': http://www.acme.com/identifiers/patient
.... value Σ1..1stringPublication Identifier Value
Example General': 123456
.... assigner Σ1..1Reference(Organization)Organization that issued id (may be just text)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
..... display Σ1..1stringPublication Vendor Name
... status ?!Σ1..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required)
... type Σ1..1CodeableConceptKind of composition (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ1..1CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriLOINC Coding System
..... version Σ1..1stringLOINC Code Version
..... code Σ1..1codeLIVD Mappipng Publication LOINC Code
..... display Σ1..1stringRepresentation defined by the system
... date Σ1..1dateTimeComposition editing time
... author Σ1..1Reference(Organization)Who and/or what authored the composition
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... display Σ1..1stringVendor Name
... title Σ1..1stringLIVD Mapping Publication Title
... section I1..*BackboneElementComposition is broken into sections
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... title 1..1stringLabel for section (e.g. for Devices)
.... code 1..1CodeableConceptdevices | concept-map | loinc-codes | ivd-test-codes | entry-definitions
Binding: LIVDSectionType (required)
.... author 0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the section
.... entry I1..*Reference(Resource)A reference to data that supports this section
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣI1..1stringLiteral reference, Relative, internal or absolute URL
..... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathNameConformanceValueSet
Composition.languageLanguagepreferredCommon Languages
Composition.identifier.assigner.typeResourceTypeextensibleResourceType
Composition.statusCompositionStatusrequiredCompositionStatus
Composition.typeFHIR Document Type CodespreferredFHIRDocumentTypeCodes
Composition.author.typeResourceTypeextensibleResourceType
Composition.attester.modeCompositionAttestationModerequiredCompositionAttestationMode
Composition.relatesTo.codeDocumentRelationshipTyperequiredDocumentRelationshipType
Composition.event.code?extexamplehttp://terminology.hl7.org/ValueSet/v3-ActCode
Composition.section.codeLIVDSectionTyperequiredLIVDSectionType
Composition.section.entry.typeResourceTypeextensibleResourceType

Constraints

IdPathDetailsRequirements
dom-2CompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-4CompositionIf 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-3CompositionIf 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-6CompositionA resource should have narrative for robust management
: text.div.exists()
dom-5CompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
ele-1Composition.sectionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
cmp-1Composition.sectionA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2Composition.sectionA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()