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 Composed Value Set

Official URL: https://healthterminologies.gov.au/fhir/StructureDefinition/composed-value-set-4 | Version: 1.0.0
Active as of 2023-07-31 | Computable Name: Ncts_composed_value_set

This StructureDefinition describes the NCTS Composed Value Set, a profile of the FHIR® ValueSet resource. The NCTS Composed Value Set is designed to represent value sets 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 value sets in FHIR, and an opinionated approach to versioning that is compatible with the syndication model that NCTS uses.

Usages:

- Examples for this Profile: AustralianIndigenousStatus, AustralianMedication, AustralianStatesAndTerritories, ContactRelationshipType... Show 6 more, IndividualHealthcareIdentifierRecordStatus, IndividualHealthcareIdentifierStatus, MedicationReasonTaken, MedicineSubstitutionReason, ReasonForRequest and RouteOfAdministration

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
--- | --- | --- | --- | ---
ValueSet | C | 0..* | ValueSet | A set of codes drawn from one or more code systems Constraints: vsd-0
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 value set, represented as a URI (globally unique)
identifier | Σ | 1..* | Identifier | Additional identifier for the value set (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 value set
name | Σ C | 1..1 | string | Name for this value set (computer friendly)
title | Σ | 1..1 | string | Name for this value set (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 value set
copyright |  | 1..1 | markdown | Use and/or publishing restrictions
compose |  | 1..1 | BackboneElement | Content logical definition of the value set (CLD)
include | Σ C | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) Constraints: vsd-1, vsd-2, vsd-3
system | Σ C | 0..1 | uri | The system the codes come from
Documentation for this format

#### Terminology Bindings

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

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | ValueSet | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | ValueSet | 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 | ValueSet | 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 | ValueSet | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | ValueSet | 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())`
vsd-0 | warning | ValueSet | 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}')`
vsd-1 | error | ValueSet.compose.include | A value set include/exclude SHALL have a value set or a system | `valueSet.exists() or system.exists()`
vsd-2 | error | ValueSet.compose.include | A value set with concepts or filters SHALL include a system | `(concept.exists() or filter.exists()) implies system.exists()`
vsd-3 | error | ValueSet.compose.include | Cannot have both concept and filter | `concept.empty() or filter.empty()`

This structure is derived from ValueSet

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
ValueSet |  | 0..* | ValueSet | A set of codes drawn from one or more code systems
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 value set, represented as a URI (globally unique)
identifier |  | 1..* | Identifier | Additional identifier for the value set (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 value set
name |  | 1..1 | string | Name for this value set (computer friendly)
title |  | 1..1 | string | Name for this value set (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 value set
immutable |  | 0..0 |  | Indicates whether or not any change to the content logical definition may occur
copyright |  | 1..1 | markdown | Use and/or publishing restrictions
compose |  | 1..1 | BackboneElement | Content logical definition of the value set (CLD)
modifierExtension |  | 0..0 |  | Extension
lockedDate |  | 0..0 |  | Fixed date for references with no specified version (transitive)
include |  |  |  |
modifierExtension |  | 0..0 |  | Extension
concept |  |  |  |
modifierExtension |  | 0..0 |  | Extension
designation |  |  |  |
modifierExtension |  | 0..0 |  | Extension
filter |  |  |  |
modifierExtension |  | 0..0 |  | Extension
expansion |  | 0..0 |  | Used when the value set is "expanded"
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
ValueSet | C | 0..* | ValueSet | A set of codes drawn from one or more code systems Constraints: vsd-0
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 value set, represented as a URI (globally unique)
identifier | Σ | 1..* | Identifier | Additional identifier for the value set (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 value set
name | Σ C | 1..1 | string | Name for this value set (computer friendly)
title | Σ | 1..1 | string | Name for this value set (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 value set
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
purpose |  | 0..1 | markdown | Why this value set is defined
copyright |  | 1..1 | markdown | Use and/or publishing restrictions
compose |  | 1..1 | BackboneElement | Content logical definition of the value set (CLD)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
inactive | Σ | 0..1 | boolean | Whether inactive codes are in the value set
include | Σ C | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) Constraints: vsd-1, vsd-2, vsd-3
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system | Σ C | 0..1 | uri | The system the codes come from
version | Σ | 0..1 | string | Specific version of the code system referred to
concept | C | 0..* | BackboneElement | A concept defined in the system
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
code |  | 1..1 | code | Code or expression from system
display |  | 0..1 | string | Text to display for this code for this value set in this valueset
designation |  | 0..* | BackboneElement | Additional representations for this 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 |  | 0..1 | Coding | Types of uses of designations Binding: DesignationUse (extensible): Details of how a designation would be used.
value |  | 1..1 | string | The text value for this designation
filter | Σ C | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
property | Σ | 1..1 | code | A property/filter defined by the code system
op | Σ | 1..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 | Code from the system, or regex criteria, or boolean value for exists
valueSet | Σ C | 0..* | canonical(ValueSet) | Select the contents included in this value set
exclude | C | 0..* | See include (ValueSet) | Explicitly exclude codes from a code system or other value sets
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
ValueSet.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
ValueSet.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
ValueSet.identifier.​type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
ValueSet.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std.
ValueSet.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std.
ValueSet.compose.include.​concept.designation.​language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
ValueSet.compose.include.​concept.designation.​use | Base | extensible | Designation Use | 📍4.0.1 | FHIR Std.
ValueSet.compose.include.​filter.op | Base | required | FilterOperator | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | ValueSet | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | ValueSet | 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 | ValueSet | 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 | ValueSet | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | ValueSet | 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()`
vsd-0 | warning | ValueSet | 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}')`
vsd-1 | error | ValueSet.compose.include | A value set include/exclude SHALL have a value set or a system | `valueSet.exists() or system.exists()`
vsd-2 | error | ValueSet.compose.include | A value set with concepts or filters SHALL include a system | `(concept.exists() or filter.exists()) implies system.exists()`
vsd-3 | error | ValueSet.compose.include | Cannot have both concept and filter | `concept.empty() or filter.empty()`
vsd-6 | error | ValueSet.expansion.contains | SHALL have a code or a display | `code.exists() or display.exists()`
vsd-9 | error | ValueSet.expansion.contains | Must have a code if not abstract | `code.exists() or abstract = true`
vsd-10 | error | ValueSet.expansion.contains | Must have a system if a code is present | `code.empty() or system.exists()`

This structure is derived from ValueSet

Summary

Mandatory: 14 elements(1 nested mandatory element)
Fixed: 1 element
Prohibited: 14 elements

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
ValueSet | C | 0..* | ValueSet | A set of codes drawn from one or more code systems Constraints: vsd-0
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 value set, represented as a URI (globally unique)
identifier | Σ | 1..* | Identifier | Additional identifier for the value set (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 value set
name | Σ C | 1..1 | string | Name for this value set (computer friendly)
title | Σ | 1..1 | string | Name for this value set (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 value set
copyright |  | 1..1 | markdown | Use and/or publishing restrictions
compose |  | 1..1 | BackboneElement | Content logical definition of the value set (CLD)
include | Σ C | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) Constraints: vsd-1, vsd-2, vsd-3
system | Σ C | 0..1 | uri | The system the codes come from
Documentation for this format

#### Terminology Bindings

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

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | ValueSet | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | ValueSet | 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 | ValueSet | 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 | ValueSet | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | ValueSet | 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())`
vsd-0 | warning | ValueSet | 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}')`
vsd-1 | error | ValueSet.compose.include | A value set include/exclude SHALL have a value set or a system | `valueSet.exists() or system.exists()`
vsd-2 | error | ValueSet.compose.include | A value set with concepts or filters SHALL include a system | `(concept.exists() or filter.exists()) implies system.exists()`
vsd-3 | error | ValueSet.compose.include | Cannot have both concept and filter | `concept.empty() or filter.empty()`

Differential View

This structure is derived from ValueSet

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
ValueSet |  | 0..* | ValueSet | A set of codes drawn from one or more code systems
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 value set, represented as a URI (globally unique)
identifier |  | 1..* | Identifier | Additional identifier for the value set (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 value set
name |  | 1..1 | string | Name for this value set (computer friendly)
title |  | 1..1 | string | Name for this value set (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 value set
immutable |  | 0..0 |  | Indicates whether or not any change to the content logical definition may occur
copyright |  | 1..1 | markdown | Use and/or publishing restrictions
compose |  | 1..1 | BackboneElement | Content logical definition of the value set (CLD)
modifierExtension |  | 0..0 |  | Extension
lockedDate |  | 0..0 |  | Fixed date for references with no specified version (transitive)
include |  |  |  |
modifierExtension |  | 0..0 |  | Extension
concept |  |  |  |
modifierExtension |  | 0..0 |  | Extension
designation |  |  |  |
modifierExtension |  | 0..0 |  | Extension
filter |  |  |  |
modifierExtension |  | 0..0 |  | Extension
expansion |  | 0..0 |  | Used when the value set is "expanded"
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
ValueSet | C | 0..* | ValueSet | A set of codes drawn from one or more code systems Constraints: vsd-0
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 value set, represented as a URI (globally unique)
identifier | Σ | 1..* | Identifier | Additional identifier for the value set (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 value set
name | Σ C | 1..1 | string | Name for this value set (computer friendly)
title | Σ | 1..1 | string | Name for this value set (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 value set
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
purpose |  | 0..1 | markdown | Why this value set is defined
copyright |  | 1..1 | markdown | Use and/or publishing restrictions
compose |  | 1..1 | BackboneElement | Content logical definition of the value set (CLD)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
inactive | Σ | 0..1 | boolean | Whether inactive codes are in the value set
include | Σ C | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) Constraints: vsd-1, vsd-2, vsd-3
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system | Σ C | 0..1 | uri | The system the codes come from
version | Σ | 0..1 | string | Specific version of the code system referred to
concept | C | 0..* | BackboneElement | A concept defined in the system
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
code |  | 1..1 | code | Code or expression from system
display |  | 0..1 | string | Text to display for this code for this value set in this valueset
designation |  | 0..* | BackboneElement | Additional representations for this 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 |  | 0..1 | Coding | Types of uses of designations Binding: DesignationUse (extensible): Details of how a designation would be used.
value |  | 1..1 | string | The text value for this designation
filter | Σ C | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
property | Σ | 1..1 | code | A property/filter defined by the code system
op | Σ | 1..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 | Code from the system, or regex criteria, or boolean value for exists
valueSet | Σ C | 0..* | canonical(ValueSet) | Select the contents included in this value set
exclude | C | 0..* | See include (ValueSet) | Explicitly exclude codes from a code system or other value sets
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
ValueSet.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
ValueSet.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
ValueSet.identifier.​type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
ValueSet.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std.
ValueSet.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std.
ValueSet.compose.include.​concept.designation.​language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
ValueSet.compose.include.​concept.designation.​use | Base | extensible | Designation Use | 📍4.0.1 | FHIR Std.
ValueSet.compose.include.​filter.op | Base | required | FilterOperator | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | ValueSet | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | ValueSet | 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 | ValueSet | 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 | ValueSet | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | ValueSet | 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()`
vsd-0 | warning | ValueSet | 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}')`
vsd-1 | error | ValueSet.compose.include | A value set include/exclude SHALL have a value set or a system | `valueSet.exists() or system.exists()`
vsd-2 | error | ValueSet.compose.include | A value set with concepts or filters SHALL include a system | `(concept.exists() or filter.exists()) implies system.exists()`
vsd-3 | error | ValueSet.compose.include | Cannot have both concept and filter | `concept.empty() or filter.empty()`
vsd-6 | error | ValueSet.expansion.contains | SHALL have a code or a display | `code.exists() or display.exists()`
vsd-9 | error | ValueSet.expansion.contains | Must have a code if not abstract | `code.exists() or abstract = true`
vsd-10 | error | ValueSet.expansion.contains | Must have a system if a code is present | `code.empty() or system.exists()`

This structure is derived from ValueSet

Summary

Mandatory: 14 elements(1 nested mandatory element)
Fixed: 1 element
Prohibited: 14 elements

Other representations of profile: CSV, Excel, Schematron