This page is part of the Loinc/IVD Mapping FHIR IG (v0.1.0: STU 1 Draft) based on FHIR v3.5.0. . 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 CodeSystem (LOINC)

The official URL for this profile is: 

http://hl7.org/fhir/uv/livd/StructureDefinition/codesystem-loinc-uv-livd

Formal Views of Profile Content

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

This structure is derived from CodeSystem

Summary

Mandatory: 17 elements (4 nested mandatory elements)
Prohibited: 18 elements

This structure is derived from CodeSystem

NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem 0..*LIVD CodeSystem (LOINC)
... url 1..1uri& (Coding.system)
... identifier 1..1Identifier
... version 1..1string& (Coding.version)
... name 1..1string
... title 1..1string
... status 1..1code
... experimental 0..0
... date 0..0
... publisher 1..1string
... contact 0..0
... description 0..0
... useContext 0..0
... jurisdiction 0..0
... purpose 0..0
... copyright 1..1markdown
... caseSensitive 0..0
... valueSet 0..0
... hierarchyMeaning 0..0
... compositional 0..0
... versionNeeded 0..0
... content 1..1codefragment
... count 0..0
... filter 0..0
... property 4..6BackboneElementAdditional information supplied about each concept
.... code 1..1codeIdentifies the property on the concepts, and when referred to in operations
.... uri 0..0
.... description 1..1stringWhy the property is defined, and/or what it conveys
.... type 1..1codecode | Coding | string | integer | boolean | dateTime
... concept 1..*BackboneElementConcepts in the code system
.... code 1..1codeCode that identifies concept
.... display 1..1stringText to display to the user
.... definition 0..0
.... designation 0..0
.... property 4..6BackboneElementProperty value for the concept
..... code 1..1codeReference to CodeSystem.property.code
..... value[x] 1..1code, Coding, string, integer, boolean, dateTime, decimalValue of the property for this concept
.... concept 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem I0..*LIVD CodeSystem (LOINC)
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: 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
... url Σ1..1uri& (Coding.system)
... identifier Σ1..1IdentifierAdditional identifier for the code system
... version Σ1..1string& (Coding.version)
... name ΣI1..1stringName for this code system (computer friendly)
... title Σ1..1stringName for this code system (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... publisher Σ1..1stringName of the publisher (organization or individual)
... copyright 1..1markdownUse and/or publishing restrictions
... content Σ1..1codefragment
Binding: CodeSystemContentMode (required)
... supplements Σ0..1canonical(CodeSystem)Code System this adds designations and properties to
... property ΣI4..6BackboneElementAdditional information supplied about each concept
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... code Σ1..1codeIdentifies the property on the concepts, and when referred to in operations
.... description Σ1..1stringWhy the property is defined, and/or what it conveys
.... type Σ1..1codecode | Coding | string | integer | boolean | dateTime
Binding: PropertyType (required)
... concept I1..*BackboneElementConcepts in the code system
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... code 1..1codeCode that identifies concept
.... display 1..1stringText to display to the user
.... property I4..6BackboneElementProperty value for the concept
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
..... code 1..1codeReference to CodeSystem.property.code
..... value[x] 1..1code, Coding, string, integer, boolean, dateTime, decimalValue of the property for this concept

doco Documentation for this format

This structure is derived from CodeSystem

Summary

Mandatory: 17 elements (4 nested mandatory elements)
Prohibited: 18 elements

Differential View

This structure is derived from CodeSystem

NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem 0..*LIVD CodeSystem (LOINC)
... url 1..1uri& (Coding.system)
... identifier 1..1Identifier
... version 1..1string& (Coding.version)
... name 1..1string
... title 1..1string
... status 1..1code
... experimental 0..0
... date 0..0
... publisher 1..1string
... contact 0..0
... description 0..0
... useContext 0..0
... jurisdiction 0..0
... purpose 0..0
... copyright 1..1markdown
... caseSensitive 0..0
... valueSet 0..0
... hierarchyMeaning 0..0
... compositional 0..0
... versionNeeded 0..0
... content 1..1codefragment
... count 0..0
... filter 0..0
... property 4..6BackboneElementAdditional information supplied about each concept
.... code 1..1codeIdentifies the property on the concepts, and when referred to in operations
.... uri 0..0
.... description 1..1stringWhy the property is defined, and/or what it conveys
.... type 1..1codecode | Coding | string | integer | boolean | dateTime
... concept 1..*BackboneElementConcepts in the code system
.... code 1..1codeCode that identifies concept
.... display 1..1stringText to display to the user
.... definition 0..0
.... designation 0..0
.... property 4..6BackboneElementProperty value for the concept
..... code 1..1codeReference to CodeSystem.property.code
..... value[x] 1..1code, Coding, string, integer, boolean, dateTime, decimalValue of the property for this concept
.... concept 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem I0..*LIVD CodeSystem (LOINC)
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: 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
... url Σ1..1uri& (Coding.system)
... identifier Σ1..1IdentifierAdditional identifier for the code system
... version Σ1..1string& (Coding.version)
... name ΣI1..1stringName for this code system (computer friendly)
... title Σ1..1stringName for this code system (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... publisher Σ1..1stringName of the publisher (organization or individual)
... copyright 1..1markdownUse and/or publishing restrictions
... content Σ1..1codefragment
Binding: CodeSystemContentMode (required)
... supplements Σ0..1canonical(CodeSystem)Code System this adds designations and properties to
... property ΣI4..6BackboneElementAdditional information supplied about each concept
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... code Σ1..1codeIdentifies the property on the concepts, and when referred to in operations
.... description Σ1..1stringWhy the property is defined, and/or what it conveys
.... type Σ1..1codecode | Coding | string | integer | boolean | dateTime
Binding: PropertyType (required)
... concept I1..*BackboneElementConcepts in the code system
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... code 1..1codeCode that identifies concept
.... display 1..1stringText to display to the user
.... property I4..6BackboneElementProperty value for the concept
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
..... code 1..1codeReference to CodeSystem.property.code
..... value[x] 1..1code, Coding, string, integer, boolean, dateTime, decimalValue of the property for this concept

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathNameConformanceValueSet
CodeSystem.languageLanguagepreferredCommon Languages
CodeSystem.statusPublicationStatusrequiredPublicationStatus
CodeSystem.contentCodeSystemContentModerequiredCodeSystemContentMode
CodeSystem.filter.operatorFilterOperatorrequiredFilterOperator
CodeSystem.property.typePropertyTyperequiredPropertyType
CodeSystem.concept.designation.languageLanguagepreferredCommon Languages
CodeSystem.concept.designation.useDesignation UseextensibleDesignationUse

Constraints

IdPathDetailsRequirements
dom-2CodeSystemIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-4CodeSystemIf 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-3CodeSystemIf 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-6CodeSystemA resource should have narrative for robust management
: text.div.exists()
dom-5CodeSystemIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
csd-1CodeSystemWithin a code system definition, all the codes SHALL be unique
: concept.code.combine($this.descendants().concept.code).isDistinct()
csd-0CodeSystemName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
ele-1CodeSystem.propertyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CodeSystem.conceptAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CodeSystem.concept.propertyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())