HL7® Austria FHIR® Core Implementation Guide
1.1.0 - STU2
HL7® Austria FHIR® Core Implementation Guide - Local Development build (v1.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: http://hl7.at/fhir/HL7ATCoreProfiles/5.0.0/StructureDefinition/at-core-valueset | Version: 1.1.0 | |||
Active as of 2024-10-25 | Responsible: HL7® Austria, TC FHIR® | Computable Name: HL7ATCoreValueSet |
HL7® Austria FHIR® Core Profile for valuesets in Austria. The HL7® AT Core ValueSet is based upon the core FHIR® ValueSet Resource and defines the use of the OID extension.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ValueSet
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ValueSet | 0..* | ValueSet | A set of codes drawn from one or more code systems | |
compose | ||||
include | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
systemOID | 0..1 | oid | OID of the system URL: http://hl7.at/fhir/HL7ATCoreProfiles/5.0.0/StructureDefinition/at-core-ext-valueset-systemoid | |
expansion | ||||
contains | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
systemOID | 0..1 | oid | OID of the system URL: http://hl7.at/fhir/HL7ATCoreProfiles/5.0.0/StructureDefinition/at-core-ext-valueset-systemoid | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ValueSet | C | 0..* | ValueSet | A set of codes drawn from one or more code systems cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 0..* | Resource | Contained, inline Resources | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ValueSet.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0 from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ValueSet | C | 0..* | ValueSet | A set of codes drawn from one or more code systems cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
url | ΣC | 0..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) cnl-1: URL should not contain | or # - these characters make processing canonical references problematic | ||||
identifier | Σ | 0..* | Identifier | Additional identifier for the value set (business identifier) | ||||
version | Σ | 0..1 | string | Business version of the value set | ||||
versionAlgorithm[x] | Σ | 0..1 | How to compare versions Binding: VersionAlgorithm (extensible) | |||||
versionAlgorithmString | string | |||||||
versionAlgorithmCoding | Coding | |||||||
name | ΣC | 0..1 | string | Name for this value set (computer friendly) | ||||
title | Σ | 0..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 | Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
date | Σ | 0..1 | dateTime | Date last changed | ||||
publisher | Σ | 0..1 | string | Name of the publisher/steward (organization or individual) | ||||
contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
description | 0..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: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
immutable | Σ | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur | ||||
purpose | 0..1 | markdown | Why this value set is defined | |||||
copyright | 0..1 | markdown | Use and/or publishing restrictions | |||||
copyrightLabel | 0..1 | string | Copyright holder and year(s) | |||||
approvalDate | 0..1 | date | When the ValueSet was approved by publisher | |||||
lastReviewDate | 0..1 | date | When the ValueSet was last reviewed by the publisher | |||||
effectivePeriod | Σ | 0..1 | Period | When the ValueSet is expected to be used | ||||
topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: DefinitionTopic (example) | |||||
author | 0..* | ContactDetail | Who authored the ValueSet | |||||
editor | 0..* | ContactDetail | Who edited the ValueSet | |||||
reviewer | 0..* | ContactDetail | Who reviewed the ValueSet | |||||
endorser | 0..* | ContactDetail | Who endorsed the ValueSet | |||||
relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations, etc | |||||
compose | 0..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 | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
lockedDate | Σ | 0..1 | date | Fixed date for references with no specified version (transitive) | ||||
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) vsd-1: A value set include/exclude SHALL have a value set or a system vsd-2: A value set with concepts or filters SHALL include a system vsd-3: Cannot have both concept and filter | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
systemOID | 0..1 | oid | OID of the system URL: http://hl7.at/fhir/HL7ATCoreProfiles/5.0.0/StructureDefinition/at-core-ext-valueset-systemoid | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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 | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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 | C | 0..* | BackboneElement | Additional representations for this concept vsd-11: Must have a value for concept.designation.use if concept.designation.additionalUse is present | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
language | 0..1 | code | Human language of the designation Binding: AllLanguages (required): IETF language tag for a human language
| |||||
use | C | 0..1 | Coding | Types of uses of designations Binding: DesignationUse (extensible): Details of how a designation would be used. | ||||
additionalUse | C | 0..* | Coding | Additional ways 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 | |||||
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 | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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 | child-of | descendent-leaf | 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 | ||||
copyright | 0..1 | string | A copyright statement for the specific code system included in the value set | |||||
exclude | 0..* | See include (ValueSet) | Explicitly exclude codes from a code system or other value sets | |||||
property | 0..* | string | Property to return if client doesn't override | |||||
expansion | 0..1 | BackboneElement | Used when the value set is "expanded" | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
identifier | 0..1 | uri | Identifies the value set expansion (business identifier) | |||||
next | 0..1 | uri | Opaque urls for paging through expansion results | |||||
timestamp | 1..1 | dateTime | Time ValueSet expansion happened | |||||
total | 0..1 | integer | Total number of codes in the expansion | |||||
offset | 0..1 | integer | Offset at which this resource starts | |||||
parameter | 0..* | BackboneElement | Parameter that controlled the expansion process | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
name | 1..1 | string | Name as assigned by the client or server | |||||
value[x] | 0..1 | Value of the named parameter | ||||||
valueString | string | |||||||
valueBoolean | boolean | |||||||
valueInteger | integer | |||||||
valueDecimal | decimal | |||||||
valueUri | uri | |||||||
valueCode | code | |||||||
valueDateTime | dateTime | |||||||
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 | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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 | |||||
contains | C | 0..* | BackboneElement | Codes in the value set vsd-6: SHALL have a code or a display vsd-9: SHALL have a code if not abstract vsd-10: SHALL have a system if a code is present | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
systemOID | 0..1 | oid | OID of the system URL: http://hl7.at/fhir/HL7ATCoreProfiles/5.0.0/StructureDefinition/at-core-ext-valueset-systemoid | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
system | C | 0..1 | uri | System value for the code | ||||
abstract | C | 0..1 | boolean | If user cannot select this entry | ||||
inactive | 0..1 | boolean | If concept is inactive in the code system | |||||
version | 0..1 | string | Version in which this code/display is defined | |||||
code | C | 0..1 | code | Code - if blank, this is not a selectable code | ||||
display | C | 0..1 | string | User display for the concept | ||||
designation | 0..* | See designation (ValueSet) | Additional representations for this item | |||||
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 | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 1..1 | code | Reference to ValueSet.expansion.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 | |||||||
subProperty | 0..* | BackboneElement | SubProperty value for the concept | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 1..1 | code | Reference to ValueSet.expansion.property.code | |||||
value[x] | 1..1 | Value of the subproperty for this concept | ||||||
valueCode | code | |||||||
valueCoding | Coding | |||||||
valueString | string | |||||||
valueInteger | integer | |||||||
valueBoolean | boolean | |||||||
valueDateTime | dateTime | |||||||
valueDecimal | decimal | |||||||
contains | 0..* | See contains (ValueSet) | Codes contained under this entry | |||||
scope | 0..1 | BackboneElement | Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
inclusionCriteria | 0..1 | string | Criteria describing which concepts or codes should be included and why | |||||
exclusionCriteria | 0..1 | string | Criteria describing which concepts or codes should be excluded and why | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
ValueSet.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
ValueSet.versionAlgorithm[x] | extensible | VersionAlgorithmhttp://hl7.org/fhir/ValueSet/version-algorithm from the FHIR Standard | |
ValueSet.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0 from the FHIR Standard | |
ValueSet.jurisdiction | extensible | JurisdictionValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | |
ValueSet.topic | example | DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topic from the FHIR Standard | |
ValueSet.compose.include.concept.designation.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
ValueSet.compose.include.concept.designation.use | extensible | DesignationUsehttp://hl7.org/fhir/ValueSet/designation-use from the FHIR Standard | |
ValueSet.compose.include.concept.designation.additionalUse | extensible | DesignationUsehttp://hl7.org/fhir/ValueSet/designation-use from the FHIR Standard | |
ValueSet.compose.include.filter.op | required | FilterOperatorhttp://hl7.org/fhir/ValueSet/filter-operator|5.0.0 from the FHIR Standard |
This structure is derived from ValueSet
Differential View
This structure is derived from ValueSet
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ValueSet | 0..* | ValueSet | A set of codes drawn from one or more code systems | |
compose | ||||
include | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
systemOID | 0..1 | oid | OID of the system URL: http://hl7.at/fhir/HL7ATCoreProfiles/5.0.0/StructureDefinition/at-core-ext-valueset-systemoid | |
expansion | ||||
contains | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
systemOID | 0..1 | oid | OID of the system URL: http://hl7.at/fhir/HL7ATCoreProfiles/5.0.0/StructureDefinition/at-core-ext-valueset-systemoid | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ValueSet | C | 0..* | ValueSet | A set of codes drawn from one or more code systems cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 0..* | Resource | Contained, inline Resources | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ValueSet.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0 from the FHIR Standard |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ValueSet | C | 0..* | ValueSet | A set of codes drawn from one or more code systems cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
url | ΣC | 0..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) cnl-1: URL should not contain | or # - these characters make processing canonical references problematic | ||||
identifier | Σ | 0..* | Identifier | Additional identifier for the value set (business identifier) | ||||
version | Σ | 0..1 | string | Business version of the value set | ||||
versionAlgorithm[x] | Σ | 0..1 | How to compare versions Binding: VersionAlgorithm (extensible) | |||||
versionAlgorithmString | string | |||||||
versionAlgorithmCoding | Coding | |||||||
name | ΣC | 0..1 | string | Name for this value set (computer friendly) | ||||
title | Σ | 0..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 | Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
date | Σ | 0..1 | dateTime | Date last changed | ||||
publisher | Σ | 0..1 | string | Name of the publisher/steward (organization or individual) | ||||
contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
description | 0..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: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
immutable | Σ | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur | ||||
purpose | 0..1 | markdown | Why this value set is defined | |||||
copyright | 0..1 | markdown | Use and/or publishing restrictions | |||||
copyrightLabel | 0..1 | string | Copyright holder and year(s) | |||||
approvalDate | 0..1 | date | When the ValueSet was approved by publisher | |||||
lastReviewDate | 0..1 | date | When the ValueSet was last reviewed by the publisher | |||||
effectivePeriod | Σ | 0..1 | Period | When the ValueSet is expected to be used | ||||
topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: DefinitionTopic (example) | |||||
author | 0..* | ContactDetail | Who authored the ValueSet | |||||
editor | 0..* | ContactDetail | Who edited the ValueSet | |||||
reviewer | 0..* | ContactDetail | Who reviewed the ValueSet | |||||
endorser | 0..* | ContactDetail | Who endorsed the ValueSet | |||||
relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations, etc | |||||
compose | 0..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 | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
lockedDate | Σ | 0..1 | date | Fixed date for references with no specified version (transitive) | ||||
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) vsd-1: A value set include/exclude SHALL have a value set or a system vsd-2: A value set with concepts or filters SHALL include a system vsd-3: Cannot have both concept and filter | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
systemOID | 0..1 | oid | OID of the system URL: http://hl7.at/fhir/HL7ATCoreProfiles/5.0.0/StructureDefinition/at-core-ext-valueset-systemoid | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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 | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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 | C | 0..* | BackboneElement | Additional representations for this concept vsd-11: Must have a value for concept.designation.use if concept.designation.additionalUse is present | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
language | 0..1 | code | Human language of the designation Binding: AllLanguages (required): IETF language tag for a human language
| |||||
use | C | 0..1 | Coding | Types of uses of designations Binding: DesignationUse (extensible): Details of how a designation would be used. | ||||
additionalUse | C | 0..* | Coding | Additional ways 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 | |||||
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 | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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 | child-of | descendent-leaf | 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 | ||||
copyright | 0..1 | string | A copyright statement for the specific code system included in the value set | |||||
exclude | 0..* | See include (ValueSet) | Explicitly exclude codes from a code system or other value sets | |||||
property | 0..* | string | Property to return if client doesn't override | |||||
expansion | 0..1 | BackboneElement | Used when the value set is "expanded" | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
identifier | 0..1 | uri | Identifies the value set expansion (business identifier) | |||||
next | 0..1 | uri | Opaque urls for paging through expansion results | |||||
timestamp | 1..1 | dateTime | Time ValueSet expansion happened | |||||
total | 0..1 | integer | Total number of codes in the expansion | |||||
offset | 0..1 | integer | Offset at which this resource starts | |||||
parameter | 0..* | BackboneElement | Parameter that controlled the expansion process | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
name | 1..1 | string | Name as assigned by the client or server | |||||
value[x] | 0..1 | Value of the named parameter | ||||||
valueString | string | |||||||
valueBoolean | boolean | |||||||
valueInteger | integer | |||||||
valueDecimal | decimal | |||||||
valueUri | uri | |||||||
valueCode | code | |||||||
valueDateTime | dateTime | |||||||
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 | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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 | |||||
contains | C | 0..* | BackboneElement | Codes in the value set vsd-6: SHALL have a code or a display vsd-9: SHALL have a code if not abstract vsd-10: SHALL have a system if a code is present | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
systemOID | 0..1 | oid | OID of the system URL: http://hl7.at/fhir/HL7ATCoreProfiles/5.0.0/StructureDefinition/at-core-ext-valueset-systemoid | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
system | C | 0..1 | uri | System value for the code | ||||
abstract | C | 0..1 | boolean | If user cannot select this entry | ||||
inactive | 0..1 | boolean | If concept is inactive in the code system | |||||
version | 0..1 | string | Version in which this code/display is defined | |||||
code | C | 0..1 | code | Code - if blank, this is not a selectable code | ||||
display | C | 0..1 | string | User display for the concept | ||||
designation | 0..* | See designation (ValueSet) | Additional representations for this item | |||||
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 | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 1..1 | code | Reference to ValueSet.expansion.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 | |||||||
subProperty | 0..* | BackboneElement | SubProperty value for the concept | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 1..1 | code | Reference to ValueSet.expansion.property.code | |||||
value[x] | 1..1 | Value of the subproperty for this concept | ||||||
valueCode | code | |||||||
valueCoding | Coding | |||||||
valueString | string | |||||||
valueInteger | integer | |||||||
valueBoolean | boolean | |||||||
valueDateTime | dateTime | |||||||
valueDecimal | decimal | |||||||
contains | 0..* | See contains (ValueSet) | Codes contained under this entry | |||||
scope | 0..1 | BackboneElement | Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
inclusionCriteria | 0..1 | string | Criteria describing which concepts or codes should be included and why | |||||
exclusionCriteria | 0..1 | string | Criteria describing which concepts or codes should be excluded and why | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
ValueSet.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
ValueSet.versionAlgorithm[x] | extensible | VersionAlgorithmhttp://hl7.org/fhir/ValueSet/version-algorithm from the FHIR Standard | |
ValueSet.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0 from the FHIR Standard | |
ValueSet.jurisdiction | extensible | JurisdictionValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | |
ValueSet.topic | example | DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topic from the FHIR Standard | |
ValueSet.compose.include.concept.designation.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
ValueSet.compose.include.concept.designation.use | extensible | DesignationUsehttp://hl7.org/fhir/ValueSet/designation-use from the FHIR Standard | |
ValueSet.compose.include.concept.designation.additionalUse | extensible | DesignationUsehttp://hl7.org/fhir/ValueSet/designation-use from the FHIR Standard | |
ValueSet.compose.include.filter.op | required | FilterOperatorhttp://hl7.org/fhir/ValueSet/filter-operator|5.0.0 from the FHIR Standard |
This structure is derived from ValueSet
Other representations of profile: CSV, Excel, Schematron