Medtech ALEX® AU Implementation Guide
1.0.0 - Trial Use

Medtech ALEX® AU Implementation Guide - Local Development build (v1.0.0) 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: 1.0.0
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.

Usages:

- Examples for this Profile: AustralianIndigenousStatus, AustralianStatesAndTerritories, IndividualHealthcareIdentifierRecordStatus and IndividualHealthcareIdentifierStatus

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

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

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
CodeSystem | C | 1..1 | CodeSystem | Declares the existence of and describes a code system or code system supplement Constraints: csd-0, csd-1
text |  | 1..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
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)
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
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
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)
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 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
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
definition |  | 1..1 | string | Formal definition
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
CodeSystem.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
CodeSystem.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std.
CodeSystem.content | Base | required | CodeSystemContentMode | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
csd-0 | warning | 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 | error | CodeSystem | Within a code system definition, all the codes SHALL be unique | `concept.code.combine($this.descendants().concept.code).isDistinct()`
dom-2 | error | CodeSystem | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | 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 | error | 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 | error | CodeSystem | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | CodeSystem | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`

This structure is derived from CodeSystem

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
CodeSystem |  | 1..1 | CodeSystem | Declares the existence of and describes a code system or code system supplement
implicitRules |  | 0..0 |  | A set of rules under which this content was created
text |  | 1..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..0 |  | Contained, inline Resources
modifierExtension |  | 0..0 |  | Extension
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 |  | Canonical URL of Code System this adds designations and properties to
count |  | 1..1 | unsignedInt | Total concepts in the code system
filter |  |  |  |
modifierExtension |  | 0..0 |  | Extension
property |  |  |  |
modifierExtension |  | 0..0 |  | Extension
concept |  | 1..* | BackboneElement | Concepts in the code system
modifierExtension |  | 0..0 |  | Extension
display |  | 1..1 | string | Text to display to the user
definition |  | 1..1 | string | Formal definition
designation |  |  |  |
modifierExtension |  | 0..0 |  | Extension
use |  | 1..1 | Coding | Details how this designation would be used
property |  |  |  |
modifierExtension |  | 0..0 |  | Extension
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
CodeSystem | C | 1..1 | CodeSystem | Declares the existence of and describes a code system or code system supplement Constraints: csd-0, csd-1
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 Bindings | Purpose
AllLanguages | Max Binding
text |  | 1..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
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 Bindings | Purpose
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)
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
CodeSystem.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
CodeSystem.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
CodeSystem.identifier.​type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
CodeSystem.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std.
CodeSystem.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std.
CodeSystem.hierarchyMeaning | Base | required | CodeSystemHierarchyMeaning | 📍4.0.1 | FHIR Std.
CodeSystem.content | Base | required | CodeSystemContentMode | 📍4.0.1 | FHIR Std.
CodeSystem.filter.operator | Base | required | FilterOperator | 📍4.0.1 | FHIR Std.
CodeSystem.property.​type | Base | required | PropertyType | 📍4.0.1 | FHIR Std.
CodeSystem.concept.designation.​language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
CodeSystem.concept.designation.​use | Base | extensible | Designation Use | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
csd-0 | warning | 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 | error | CodeSystem | Within a code system definition, all the codes SHALL be unique | `concept.code.combine($this.descendants().concept.code).isDistinct()`
dom-2 | error | CodeSystem | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | 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 | error | 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 | error | CodeSystem | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | CodeSystem | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must 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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
CodeSystem | C | 1..1 | CodeSystem | Declares the existence of and describes a code system or code system supplement Constraints: csd-0, csd-1
text |  | 1..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
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)
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
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
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)
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 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
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
definition |  | 1..1 | string | Formal definition
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
CodeSystem.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
CodeSystem.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std.
CodeSystem.content | Base | required | CodeSystemContentMode | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
csd-0 | warning | 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 | error | CodeSystem | Within a code system definition, all the codes SHALL be unique | `concept.code.combine($this.descendants().concept.code).isDistinct()`
dom-2 | error | CodeSystem | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | 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 | error | 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 | error | CodeSystem | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | CodeSystem | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`

Differential View

This structure is derived from CodeSystem

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
CodeSystem |  | 1..1 | CodeSystem | Declares the existence of and describes a code system or code system supplement
implicitRules |  | 0..0 |  | A set of rules under which this content was created
text |  | 1..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..0 |  | Contained, inline Resources
modifierExtension |  | 0..0 |  | Extension
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 |  | Canonical URL of Code System this adds designations and properties to
count |  | 1..1 | unsignedInt | Total concepts in the code system
filter |  |  |  |
modifierExtension |  | 0..0 |  | Extension
property |  |  |  |
modifierExtension |  | 0..0 |  | Extension
concept |  | 1..* | BackboneElement | Concepts in the code system
modifierExtension |  | 0..0 |  | Extension
display |  | 1..1 | string | Text to display to the user
definition |  | 1..1 | string | Formal definition
designation |  |  |  |
modifierExtension |  | 0..0 |  | Extension
use |  | 1..1 | Coding | Details how this designation would be used
property |  |  |  |
modifierExtension |  | 0..0 |  | Extension
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
CodeSystem | C | 1..1 | CodeSystem | Declares the existence of and describes a code system or code system supplement Constraints: csd-0, csd-1
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 Bindings | Purpose
AllLanguages | Max Binding
text |  | 1..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
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 Bindings | Purpose
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)
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
CodeSystem.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
CodeSystem.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
CodeSystem.identifier.​type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
CodeSystem.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std.
CodeSystem.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std.
CodeSystem.hierarchyMeaning | Base | required | CodeSystemHierarchyMeaning | 📍4.0.1 | FHIR Std.
CodeSystem.content | Base | required | CodeSystemContentMode | 📍4.0.1 | FHIR Std.
CodeSystem.filter.operator | Base | required | FilterOperator | 📍4.0.1 | FHIR Std.
CodeSystem.property.​type | Base | required | PropertyType | 📍4.0.1 | FHIR Std.
CodeSystem.concept.designation.​language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
CodeSystem.concept.designation.​use | Base | extensible | Designation Use | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
csd-0 | warning | 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 | error | CodeSystem | Within a code system definition, all the codes SHALL be unique | `concept.code.combine($this.descendants().concept.code).isDistinct()`
dom-2 | error | CodeSystem | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | 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 | error | 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 | error | CodeSystem | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | CodeSystem | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must 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