Medtech ALEX® Implementation Guide
0.0.1 - draft International flag

Medtech ALEX® Implementation Guide - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: NCTS Complete Code System

Official URL: https://healthterminologies.gov.au/fhir/StructureDefinition/complete-code-system-4 Version: 0.0.1
Active as of 2020-01-31 Computable Name: Ncts_complete_code_system

This StructureDefinition describes the NCTS Complete Code System, a profile of the FHIR® CodeSystem resource. The NCTS Complete Code System is designed to represent terminologies published as part of the National Clinical Terminology Service, and maximise interoperability within the NCTS ecosystem.

The purpose of this profile is to codify a set of general best practices with respect to representing code systems in FHIR, and an opinionated approach to versioning that is compatible with the syndication model that NCTS uses.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem C 1..1 CodeSystem Declares the existence of and describes a code system or code system supplement
csd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
csd-1: Within a code system definition, all the codes SHALL be unique
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
... text 1..1 Narrative Text summary of the resource, for human interpretation
ele-1: All FHIR elements must have a @value or children
... url Σ 1..1 uri Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
ele-1: All FHIR elements must have a @value or children
... identifier Σ 1..* Identifier Additional identifier for the code system (business identifier)
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
.... system Σ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Fixed Value: urn:ietf:rfc:3986
.... value Σ 1..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... name ΣC 1..1 string Name for this code system (computer friendly)
ele-1: All FHIR elements must have a @value or children
... title Σ 1..1 string Name for this code system (human friendly)
ele-1: All FHIR elements must have a @value or children
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.


ele-1: All FHIR elements must have a @value or children
... experimental Σ 1..1 boolean For testing purposes, not real usage
ele-1: All FHIR elements must have a @value or children
... date Σ 1..1 dateTime Date last changed
ele-1: All FHIR elements must have a @value or children
... publisher Σ 1..1 string Name of the publisher (organization or individual)
ele-1: All FHIR elements must have a @value or children
... description 1..1 markdown Natural language description of the code system
ele-1: All FHIR elements must have a @value or children
... copyright 1..1 markdown Use and/or publishing restrictions
ele-1: All FHIR elements must have a @value or children
... caseSensitive Σ 1..1 boolean If code comparison is case sensitive
ele-1: All FHIR elements must have a @value or children
... compositional Σ 1..1 boolean If code system defines a compositional grammar
ele-1: All FHIR elements must have a @value or children
Fixed Value: false
... versionNeeded Σ 1..1 boolean If definitions are not stable
ele-1: All FHIR elements must have a @value or children
... content Σ 1..1 code not-present | example | fragment | complete | supplement
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.


ele-1: All FHIR elements must have a @value or children
Fixed Value: complete
... count Σ 1..1 unsignedInt Total concepts in the code system
ele-1: All FHIR elements must have a @value or children
... concept 1..* BackboneElement Concepts in the code system
ele-1: All FHIR elements must have a @value or children
.... code 1..1 code Code that identifies concept
ele-1: All FHIR elements must have a @value or children
.... display 1..1 string Text to display to the user
ele-1: All FHIR elements must have a @value or children
.... definition 1..1 string Formal definition
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
CodeSystem.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
CodeSystem.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
CodeSystem.contentrequiredFixed Value: complete
http://hl7.org/fhir/ValueSet/codesystem-content-mode|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
csd-0warningCodeSystemName 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-1errorCodeSystemWithin a code system definition, all the codes SHALL be unique
: concept.code.combine($this.descendants().concept.code).isDistinct()
dom-2errorCodeSystemIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCodeSystemIf 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-4errorCodeSystemIf 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-5errorCodeSystemIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCodeSystemA 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())

This structure is derived from CodeSystem

NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem 1..1 CodeSystem Declares the existence of and describes a code system or code system supplement
... implicitRules 0..0
... text 1..1 Narrative Text summary of the resource, for human interpretation
... contained 0..0
... url 1..1 uri Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
... identifier 1..* Identifier Additional identifier for the code system (business identifier)
.... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
.... value 1..1 string The value that is unique
... version 1..1 string Business version of the code system (Coding.version)
... name 1..1 string Name for this code system (computer friendly)
... title 1..1 string Name for this code system (human friendly)
... experimental 1..1 boolean For testing purposes, not real usage
... date 1..1 dateTime Date last changed
... publisher 1..1 string Name of the publisher (organization or individual)
... contact
.... name 0..1 string Name of an individual to contact
.... telecom 1..* ContactPoint Contact details for individual or organization
... description 1..1 markdown Natural language description of the code system
... copyright 1..1 markdown Use and/or publishing restrictions
... caseSensitive 1..1 boolean If code comparison is case sensitive
... compositional 1..1 boolean If code system defines a compositional grammar
Fixed Value: false
... versionNeeded 1..1 boolean If definitions are not stable
... content 1..1 code not-present | example | fragment | complete | supplement
Fixed Value: complete
... supplements 0..0
... count 1..1 unsignedInt Total concepts in the code system
... filter
.... modifierExtension 0..0
... property
.... modifierExtension 0..0
... concept 1..* BackboneElement Concepts in the code system
.... modifierExtension 0..0
.... display 1..1 string Text to display to the user
.... definition 1..1 string Formal definition
.... designation
..... modifierExtension 0..0
..... use 1..1 Coding Details how this designation would be used
.... property
..... modifierExtension 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem C 1..1 CodeSystem Declares the existence of and describes a code system or code system supplement
csd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
csd-1: Within a code system definition, all the codes SHALL be unique
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 1..1 Narrative Text summary of the resource, for human interpretation
... extension 0..* Extension Additional content defined by implementations
... url Σ 1..1 uri Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
... identifier Σ 1..* Identifier Additional identifier for the code system (business identifier)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
.... value Σ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... version Σ 1..1 string Business version of the code system (Coding.version)
... name ΣC 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.

... experimental Σ 1..1 boolean For testing purposes, not real usage
... date Σ 1..1 dateTime Date last changed
... publisher Σ 1..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... name Σ 0..1 string Name of an individual to contact
.... telecom Σ 1..* ContactPoint Contact details for individual or organization
... description 1..1 markdown Natural language description of the code system
... useContext Σ 0..* UsageContext The context that the content is intended to support
... 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.


... purpose 0..1 markdown Why this code system is defined
... copyright 1..1 markdown Use and/or publishing restrictions
... caseSensitive Σ 1..1 boolean If code comparison is case sensitive
... valueSet Σ 0..1 canonical(ValueSet) Canonical reference to the value set with entire code system
... hierarchyMeaning Σ 0..1 code grouped-by | is-a | part-of | classified-with
Binding: CodeSystemHierarchyMeaning (required): The meaning of the hierarchy of concepts in a code system.

... compositional Σ 1..1 boolean If code system defines a compositional grammar
Fixed Value: false
... versionNeeded Σ 1..1 boolean If definitions are not stable
... content Σ 1..1 code not-present | example | fragment | complete | supplement
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: complete
... count Σ 1..1 unsignedInt Total concepts in the code system
... filter Σ 0..* BackboneElement Filter that can be used in a value set
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... code Σ 1..1 code Code that identifies the filter
.... description Σ 0..1 string How or why the filter is used
.... operator Σ 1..* code = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter.


.... value Σ 1..1 string What to use for the value
... property Σ 0..* BackboneElement Additional information supplied about each concept
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... code Σ 1..1 code Identifies the property on the concepts, and when referred to in operations
.... uri Σ 0..1 uri Formal identifier for the property
.... description Σ 0..1 string Why the property is defined, and/or what it conveys
.... type Σ 1..1 code code | Coding | string | integer | boolean | dateTime | decimal
Binding: PropertyType (required): The type of a property value.

... concept 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
.... code 1..1 code Code that identifies concept
.... display 1..1 string Text to display to the user
.... definition 1..1 string Formal definition
.... designation 0..* BackboneElement Additional representations for the concept
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... language 0..1 code Human language of the designation
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
..... use 1..1 Coding Details how this designation would be used
Binding: DesignationUse (extensible): Details of how a designation would be used.

..... value 1..1 string The text value for this designation
.... property 0..* BackboneElement Property value for the concept
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... code 1..1 code Reference to CodeSystem.property.code
..... value[x] 1..1 Value of the property for this concept
...... valueCode code
...... valueCoding Coding
...... valueString string
...... valueInteger integer
...... valueBoolean boolean
...... valueDateTime dateTime
...... valueDecimal decimal
.... concept 0..* See concept (CodeSystem) Child Concepts (is-a/contains/categorizes)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
CodeSystem.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
CodeSystem.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
CodeSystem.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
CodeSystem.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
CodeSystem.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
CodeSystem.hierarchyMeaningrequiredCodeSystemHierarchyMeaning
http://hl7.org/fhir/ValueSet/codesystem-hierarchy-meaning|4.0.1
from the FHIR Standard
CodeSystem.contentrequiredFixed Value: complete
http://hl7.org/fhir/ValueSet/codesystem-content-mode|4.0.1
from the FHIR Standard
CodeSystem.filter.operatorrequiredFilterOperator
http://hl7.org/fhir/ValueSet/filter-operator|4.0.1
from the FHIR Standard
CodeSystem.property.typerequiredPropertyType
http://hl7.org/fhir/ValueSet/concept-property-type|4.0.1
from the FHIR Standard
CodeSystem.concept.designation.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
CodeSystem.concept.designation.useextensibleDesignationUse
http://hl7.org/fhir/ValueSet/designation-use
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
csd-0warningCodeSystemName 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-1errorCodeSystemWithin a code system definition, all the codes SHALL be unique
: concept.code.combine($this.descendants().concept.code).isDistinct()
dom-2errorCodeSystemIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCodeSystemIf 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-4errorCodeSystemIf 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-5errorCodeSystemIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCodeSystemA 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 CodeSystem

Summary

Mandatory: 20 elements(2 nested mandatory elements)
Fixed: 3 elements
Prohibited: 9 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem C 1..1 CodeSystem Declares the existence of and describes a code system or code system supplement
csd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
csd-1: Within a code system definition, all the codes SHALL be unique
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
... text 1..1 Narrative Text summary of the resource, for human interpretation
ele-1: All FHIR elements must have a @value or children
... url Σ 1..1 uri Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
ele-1: All FHIR elements must have a @value or children
... identifier Σ 1..* Identifier Additional identifier for the code system (business identifier)
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
.... system Σ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Fixed Value: urn:ietf:rfc:3986
.... value Σ 1..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... name ΣC 1..1 string Name for this code system (computer friendly)
ele-1: All FHIR elements must have a @value or children
... title Σ 1..1 string Name for this code system (human friendly)
ele-1: All FHIR elements must have a @value or children
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.


ele-1: All FHIR elements must have a @value or children
... experimental Σ 1..1 boolean For testing purposes, not real usage
ele-1: All FHIR elements must have a @value or children
... date Σ 1..1 dateTime Date last changed
ele-1: All FHIR elements must have a @value or children
... publisher Σ 1..1 string Name of the publisher (organization or individual)
ele-1: All FHIR elements must have a @value or children
... description 1..1 markdown Natural language description of the code system
ele-1: All FHIR elements must have a @value or children
... copyright 1..1 markdown Use and/or publishing restrictions
ele-1: All FHIR elements must have a @value or children
... caseSensitive Σ 1..1 boolean If code comparison is case sensitive
ele-1: All FHIR elements must have a @value or children
... compositional Σ 1..1 boolean If code system defines a compositional grammar
ele-1: All FHIR elements must have a @value or children
Fixed Value: false
... versionNeeded Σ 1..1 boolean If definitions are not stable
ele-1: All FHIR elements must have a @value or children
... content Σ 1..1 code not-present | example | fragment | complete | supplement
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.


ele-1: All FHIR elements must have a @value or children
Fixed Value: complete
... count Σ 1..1 unsignedInt Total concepts in the code system
ele-1: All FHIR elements must have a @value or children
... concept 1..* BackboneElement Concepts in the code system
ele-1: All FHIR elements must have a @value or children
.... code 1..1 code Code that identifies concept
ele-1: All FHIR elements must have a @value or children
.... display 1..1 string Text to display to the user
ele-1: All FHIR elements must have a @value or children
.... definition 1..1 string Formal definition
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
CodeSystem.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
CodeSystem.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
CodeSystem.contentrequiredFixed Value: complete
http://hl7.org/fhir/ValueSet/codesystem-content-mode|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
csd-0warningCodeSystemName 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-1errorCodeSystemWithin a code system definition, all the codes SHALL be unique
: concept.code.combine($this.descendants().concept.code).isDistinct()
dom-2errorCodeSystemIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCodeSystemIf 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-4errorCodeSystemIf 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-5errorCodeSystemIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCodeSystemA 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())

Differential View

This structure is derived from CodeSystem

NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem 1..1 CodeSystem Declares the existence of and describes a code system or code system supplement
... implicitRules 0..0
... text 1..1 Narrative Text summary of the resource, for human interpretation
... contained 0..0
... url 1..1 uri Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
... identifier 1..* Identifier Additional identifier for the code system (business identifier)
.... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
.... value 1..1 string The value that is unique
... version 1..1 string Business version of the code system (Coding.version)
... name 1..1 string Name for this code system (computer friendly)
... title 1..1 string Name for this code system (human friendly)
... experimental 1..1 boolean For testing purposes, not real usage
... date 1..1 dateTime Date last changed
... publisher 1..1 string Name of the publisher (organization or individual)
... contact
.... name 0..1 string Name of an individual to contact
.... telecom 1..* ContactPoint Contact details for individual or organization
... description 1..1 markdown Natural language description of the code system
... copyright 1..1 markdown Use and/or publishing restrictions
... caseSensitive 1..1 boolean If code comparison is case sensitive
... compositional 1..1 boolean If code system defines a compositional grammar
Fixed Value: false
... versionNeeded 1..1 boolean If definitions are not stable
... content 1..1 code not-present | example | fragment | complete | supplement
Fixed Value: complete
... supplements 0..0
... count 1..1 unsignedInt Total concepts in the code system
... filter
.... modifierExtension 0..0
... property
.... modifierExtension 0..0
... concept 1..* BackboneElement Concepts in the code system
.... modifierExtension 0..0
.... display 1..1 string Text to display to the user
.... definition 1..1 string Formal definition
.... designation
..... modifierExtension 0..0
..... use 1..1 Coding Details how this designation would be used
.... property
..... modifierExtension 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem C 1..1 CodeSystem Declares the existence of and describes a code system or code system supplement
csd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
csd-1: Within a code system definition, all the codes SHALL be unique
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 1..1 Narrative Text summary of the resource, for human interpretation
... extension 0..* Extension Additional content defined by implementations
... url Σ 1..1 uri Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
... identifier Σ 1..* Identifier Additional identifier for the code system (business identifier)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
.... value Σ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... version Σ 1..1 string Business version of the code system (Coding.version)
... name ΣC 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.

... experimental Σ 1..1 boolean For testing purposes, not real usage
... date Σ 1..1 dateTime Date last changed
... publisher Σ 1..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... name Σ 0..1 string Name of an individual to contact
.... telecom Σ 1..* ContactPoint Contact details for individual or organization
... description 1..1 markdown Natural language description of the code system
... useContext Σ 0..* UsageContext The context that the content is intended to support
... 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.


... purpose 0..1 markdown Why this code system is defined
... copyright 1..1 markdown Use and/or publishing restrictions
... caseSensitive Σ 1..1 boolean If code comparison is case sensitive
... valueSet Σ 0..1 canonical(ValueSet) Canonical reference to the value set with entire code system
... hierarchyMeaning Σ 0..1 code grouped-by | is-a | part-of | classified-with
Binding: CodeSystemHierarchyMeaning (required): The meaning of the hierarchy of concepts in a code system.

... compositional Σ 1..1 boolean If code system defines a compositional grammar
Fixed Value: false
... versionNeeded Σ 1..1 boolean If definitions are not stable
... content Σ 1..1 code not-present | example | fragment | complete | supplement
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: complete
... count Σ 1..1 unsignedInt Total concepts in the code system
... filter Σ 0..* BackboneElement Filter that can be used in a value set
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... code Σ 1..1 code Code that identifies the filter
.... description Σ 0..1 string How or why the filter is used
.... operator Σ 1..* code = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter.


.... value Σ 1..1 string What to use for the value
... property Σ 0..* BackboneElement Additional information supplied about each concept
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... code Σ 1..1 code Identifies the property on the concepts, and when referred to in operations
.... uri Σ 0..1 uri Formal identifier for the property
.... description Σ 0..1 string Why the property is defined, and/or what it conveys
.... type Σ 1..1 code code | Coding | string | integer | boolean | dateTime | decimal
Binding: PropertyType (required): The type of a property value.

... concept 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
.... code 1..1 code Code that identifies concept
.... display 1..1 string Text to display to the user
.... definition 1..1 string Formal definition
.... designation 0..* BackboneElement Additional representations for the concept
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... language 0..1 code Human language of the designation
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
..... use 1..1 Coding Details how this designation would be used
Binding: DesignationUse (extensible): Details of how a designation would be used.

..... value 1..1 string The text value for this designation
.... property 0..* BackboneElement Property value for the concept
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... code 1..1 code Reference to CodeSystem.property.code
..... value[x] 1..1 Value of the property for this concept
...... valueCode code
...... valueCoding Coding
...... valueString string
...... valueInteger integer
...... valueBoolean boolean
...... valueDateTime dateTime
...... valueDecimal decimal
.... concept 0..* See concept (CodeSystem) Child Concepts (is-a/contains/categorizes)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
CodeSystem.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
CodeSystem.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
CodeSystem.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
CodeSystem.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
CodeSystem.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
CodeSystem.hierarchyMeaningrequiredCodeSystemHierarchyMeaning
http://hl7.org/fhir/ValueSet/codesystem-hierarchy-meaning|4.0.1
from the FHIR Standard
CodeSystem.contentrequiredFixed Value: complete
http://hl7.org/fhir/ValueSet/codesystem-content-mode|4.0.1
from the FHIR Standard
CodeSystem.filter.operatorrequiredFilterOperator
http://hl7.org/fhir/ValueSet/filter-operator|4.0.1
from the FHIR Standard
CodeSystem.property.typerequiredPropertyType
http://hl7.org/fhir/ValueSet/concept-property-type|4.0.1
from the FHIR Standard
CodeSystem.concept.designation.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
CodeSystem.concept.designation.useextensibleDesignationUse
http://hl7.org/fhir/ValueSet/designation-use
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
csd-0warningCodeSystemName 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-1errorCodeSystemWithin a code system definition, all the codes SHALL be unique
: concept.code.combine($this.descendants().concept.code).isDistinct()
dom-2errorCodeSystemIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCodeSystemIf 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-4errorCodeSystemIf 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-5errorCodeSystemIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCodeSystemA 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 CodeSystem

Summary

Mandatory: 20 elements(2 nested mandatory elements)
Fixed: 3 elements
Prohibited: 9 elements

 

Other representations of profile: CSV, Excel, Schematron