HL7.FHIR.UV.LIVD\LIVD SNOMED CT Fragment CodeSystem

This page is part of the Loinc/IVD Mapping FHIR IG (v0.3.0: STU 1 (FHIR R4) Ballot 2) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: LIVD SNOMED CT Fragment CodeSystem

Defining URL:

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

Version:

0.3.0

Name:

LIVDCodeSystemFragmentSNOMED

Status:

Draft as of 2018-08-14

Definition:

Profile on the CodeSystem resource to include the relevant information from SNOMED CT to enable the full mapping context without having to connect to a remote terminology service or other source of SNOMED CT terminology content.

Publisher:

HL7 International - Orders and Observations Work Group

Source Resource:

XML / JSON / Turtle

The official URL for this profile is:

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

Description

The LIVD SNOMED CT Fragment CodeSystem is a profile on the CodeSystem resource to include the relevant information from SNOMED CT to enable the full mapping context without having to connect to a remote terminology service or other source of SNOMED CT terminology content.

Formal Views of Profile Content

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

Text Summary
Differential Table
Snapshot Table
Snapshot Table (Must Support)
All

This structure is derived from CodeSystem

Summary

Mandatory: 9 elements
Must-Support: 16 elements
Fixed Value: 3 elements
Prohibited: 17 elements

This structure is derived from CodeSystem

Name	Flags	Card.	Type	Description & Constraints
CodeSystem		0..*	CodeSystem	LIVDCodeSystemFragmentSNOMED
url	S	1..1	uri	"http://snomed.info/sct"
identifier	S	1..1	Identifier	Additional identifier for the code system (business identifier)
version	S	1..1	string	& (Coding.version)
name	S	1..1	string	Name for this code system (computer friendly)
title	S	1..1	string	Name for this code system (human friendly)
status	S	1..1	code	draft \| active \| retired \| unknown
experimental		0..0
date		0..1	dateTime	Date last changed
publisher	S	1..1	string	Name of the publisher (organization or individual)
contact		0..0
description		0..0
useContext		0..0
jurisdiction		0..*	CodeableConcept	Intended jurisdiction for code system (if applicable)
purpose		0..0
copyright	S	1..1	markdown	Use and/or publishing restrictions
caseSensitive		0..1	boolean	If code comparison is case sensitive Fixed Value: false
valueSet		0..0
hierarchyMeaning		0..0
compositional		0..0
versionNeeded		0..0
content	S	1..1	code	fragment Fixed Value: fragment
supplements		0..0
count		0..0
filter		0..0
property		0..0
concept	S	1..*	BackboneElement	Concepts in the code system
code	S	1..1	code	Code that identifies concept
display	S	1..1	string	Text to display to the user
definition		0..0
designation		0..0
property		0..0
concept		0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
CodeSystem	I	0..*	CodeSystem	LIVDCodeSystemFragmentSNOMED
id	Σ	0..1	string	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language.
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	SΣ	1..1	uri	"http://snomed.info/sct"
identifier	SΣ	1..1	Identifier	Additional identifier for the code system (business identifier)
version	SΣ	1..1	string	& (Coding.version)
name	SΣI	1..1	string	Name for this code system (computer friendly)
title	SΣ	1..1	string	Name for this code system (human friendly)
status	?!SΣ	1..1	code	draft \| active \| retired \| unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
date	Σ	0..1	dateTime	Date last changed
publisher	SΣ	1..1	string	Name of the publisher (organization or individual)
jurisdiction	Σ	0..*	CodeableConcept	Intended jurisdiction for code system (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
copyright	S	1..1	markdown	Use and/or publishing restrictions
caseSensitive	Σ	0..1	boolean	If code comparison is case sensitive Fixed Value: false
content	SΣ	1..1	code	fragment Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource. Fixed Value: fragment
concept	S	1..*	BackboneElement	Concepts in the code system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	S	1..1	code	Code that identifies concept
display	S	1..1	string	Text to display to the user
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
CodeSystem	I	0..*	CodeSystem	LIVDCodeSystemFragmentSNOMED
url	Σ	1..1	uri	"http://snomed.info/sct"
identifier	Σ	1..1	Identifier	Additional identifier for the code system (business identifier)
version	Σ	1..1	string	& (Coding.version)
name	ΣI	1..1	string	Name for this code system (computer friendly)
title	Σ	1..1	string	Name for this code system (human friendly)
status	?!Σ	1..1	code	draft \| active \| retired \| unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
publisher	Σ	1..1	string	Name of the publisher (organization or individual)
copyright		1..1	markdown	Use and/or publishing restrictions
content	Σ	1..1	code	fragment Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource. Fixed Value: fragment
concept		1..*	BackboneElement	Concepts in the code system
code		1..1	code	Code that identifies concept
display		1..1	string	Text to display to the user
Documentation for this format

This structure is derived from CodeSystem

Summary

Mandatory: 9 elements
Must-Support: 16 elements
Fixed Value: 3 elements
Prohibited: 17 elements

Differential View

This structure is derived from CodeSystem

Name	Flags	Card.	Type	Description & Constraints
CodeSystem		0..*	CodeSystem	LIVDCodeSystemFragmentSNOMED
url	S	1..1	uri	"http://snomed.info/sct"
identifier	S	1..1	Identifier	Additional identifier for the code system (business identifier)
version	S	1..1	string	& (Coding.version)
name	S	1..1	string	Name for this code system (computer friendly)
title	S	1..1	string	Name for this code system (human friendly)
status	S	1..1	code	draft \| active \| retired \| unknown
experimental		0..0
date		0..1	dateTime	Date last changed
publisher	S	1..1	string	Name of the publisher (organization or individual)
contact		0..0
description		0..0
useContext		0..0
jurisdiction		0..*	CodeableConcept	Intended jurisdiction for code system (if applicable)
purpose		0..0
copyright	S	1..1	markdown	Use and/or publishing restrictions
caseSensitive		0..1	boolean	If code comparison is case sensitive Fixed Value: false
valueSet		0..0
hierarchyMeaning		0..0
compositional		0..0
versionNeeded		0..0
content	S	1..1	code	fragment Fixed Value: fragment
supplements		0..0
count		0..0
filter		0..0
property		0..0
concept	S	1..*	BackboneElement	Concepts in the code system
code	S	1..1	code	Code that identifies concept
display	S	1..1	string	Text to display to the user
definition		0..0
designation		0..0
property		0..0
concept		0..0
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
CodeSystem	I	0..*	CodeSystem	LIVDCodeSystemFragmentSNOMED
id	Σ	0..1	string	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language.
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	SΣ	1..1	uri	"http://snomed.info/sct"
identifier	SΣ	1..1	Identifier	Additional identifier for the code system (business identifier)
version	SΣ	1..1	string	& (Coding.version)
name	SΣI	1..1	string	Name for this code system (computer friendly)
title	SΣ	1..1	string	Name for this code system (human friendly)
status	?!SΣ	1..1	code	draft \| active \| retired \| unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
date	Σ	0..1	dateTime	Date last changed
publisher	SΣ	1..1	string	Name of the publisher (organization or individual)
jurisdiction	Σ	0..*	CodeableConcept	Intended jurisdiction for code system (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
copyright	S	1..1	markdown	Use and/or publishing restrictions
caseSensitive	Σ	0..1	boolean	If code comparison is case sensitive Fixed Value: false
content	SΣ	1..1	code	fragment Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource. Fixed Value: fragment
concept	S	1..*	BackboneElement	Concepts in the code system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	S	1..1	code	Code that identifies concept
display	S	1..1	string	Text to display to the user
Documentation for this format

Other representations of profile: Schematron

Terminology Bindings

Path	Conformance	ValueSet / Code
CodeSystem.language	preferred	CommonLanguages Max Binding: AllLanguages
CodeSystem.status	required	PublicationStatus
CodeSystem.jurisdiction	extensible	Jurisdiction ValueSet
CodeSystem.content	required	Fixed Value: fragment
CodeSystem.filter.operator	required	FilterOperator
CodeSystem.property.type	required	PropertyType
CodeSystem.concept.designation.language	preferred	CommonLanguages Max Binding: AllLanguages
CodeSystem.concept.designation.use	extensible	DesignationUse

Constraints

Id	Path	Details	Requirements
csd-0	CodeSystem	Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
csd-1	CodeSystem	Within a code system definition, all the codes SHALL be unique : concept.code.combine($this.descendants().concept.code).isDistinct()
dom-2	CodeSystem	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	CodeSystem	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	CodeSystem	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	CodeSystem	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	CodeSystem	A resource should have narrative for robust management : text.`div`.exists()
ele-1	CodeSystem.meta	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CodeSystem.implicitRules	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CodeSystem.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CodeSystem.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CodeSystem.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	CodeSystem.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	CodeSystem.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	CodeSystem.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	CodeSystem.url	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CodeSystem.identifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CodeSystem.version	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CodeSystem.name	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CodeSystem.title	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CodeSystem.status	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CodeSystem.date	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CodeSystem.publisher	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CodeSystem.jurisdiction	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CodeSystem.copyright	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CodeSystem.caseSensitive	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CodeSystem.content	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CodeSystem.filter.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	CodeSystem.filter.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	CodeSystem.filter.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	CodeSystem.filter.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	CodeSystem.filter.code	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CodeSystem.filter.description	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CodeSystem.filter.operator	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CodeSystem.filter.value	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CodeSystem.property.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	CodeSystem.property.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	CodeSystem.property.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	CodeSystem.property.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	CodeSystem.property.code	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CodeSystem.property.uri	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CodeSystem.property.description	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CodeSystem.property.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CodeSystem.concept	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CodeSystem.concept.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	CodeSystem.concept.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	CodeSystem.concept.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	CodeSystem.concept.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	CodeSystem.concept.code	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CodeSystem.concept.display	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CodeSystem.concept.designation.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	CodeSystem.concept.designation.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	CodeSystem.concept.designation.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	CodeSystem.concept.designation.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	CodeSystem.concept.designation.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CodeSystem.concept.designation.use	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CodeSystem.concept.designation.value	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CodeSystem.concept.property.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	CodeSystem.concept.property.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	CodeSystem.concept.property.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	CodeSystem.concept.property.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	CodeSystem.concept.property.code	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	CodeSystem.concept.property.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())