This page is part of the electronic Case Reporting (eCR) (v1.0.0: STU 1) based on FHIR R4. The current version which supercedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions
SD.40 StructureDefinition-ersd-valueset
This profile describes the eRSD value sets.
SD.40.1 Formal Views of Profile Content
Description of Profiles, Differentials, and Snapshots.
The official URL for this profile is: http://hl7.org/fhir/us/ecr/StructureDefinition/ersd-valueset
Published on Wed Jan 29 20:30:08 UTC 2020 as a active by HL7 Public Health Work Group.
This profile builds on ValueSet
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ValueSet | 0..* | ValueSet | ||
extension | 1..* | Extension | Slice: Unordered, Open by value:url | |
valueset-steward | S | 1..1 | ContactDetail | Value set steward URL: http://hl7.org/fhir/StructureDefinition/valueset-steward |
valueset-author | S | 1..1 | ContactDetail | Value set author URL: http://hl7.org/fhir/StructureDefinition/valueset-author |
identifier | S | 1..* | Identifier | RCTC value set OID |
name | S | 1..1 | string | |
title | S | 1..1 | string | RCTC value set name |
status | S | 1..1 | code | RCTC value set definition version |
description | S | 1..1 | markdown | RCTC value set description |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ValueSet | I | 0..* | ValueSet | A set of codes drawn from one or more code systems |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 1..* | Extension | Extension Slice: Unordered, Open by value:url |
valueset-steward | SI | 1..1 | ContactDetail | Value set steward URL: http://hl7.org/fhir/StructureDefinition/valueset-steward |
valueset-author | SI | 1..1 | ContactDetail | Value set author URL: http://hl7.org/fhir/StructureDefinition/valueset-author |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
url | ΣI | 0..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) |
identifier | SΣI | 1..* | Identifier | RCTC value set OID |
version | ΣI | 0..1 | string | Business version of the value set |
name | SΣI | 1..1 | string | Name for this value set (computer friendly) |
title | SΣI | 1..1 | string | RCTC value set name |
status | ?!SΣI | 1..1 | code | RCTC value set definition version Binding: PublicationStatus (required) |
experimental | ΣI | 0..1 | boolean | For testing purposes, not real usage |
date | ΣI | 0..1 | dateTime | Date last changed |
publisher | ΣI | 0..1 | string | Name of the publisher (organization or individual) |
contact | ΣI | 0..* | ContactDetail | Contact details for the publisher |
description | SI | 1..1 | markdown | RCTC value set description |
useContext | ΣI | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | ΣI | 0..* | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: Jurisdiction ValueSet (extensible) |
immutable | ΣI | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur |
purpose | I | 0..1 | markdown | Why this value set is defined |
copyright | I | 0..1 | markdown | Use and/or publishing restrictions |
compose | I | 0..1 | BackboneElement | Content logical definition of the value set (CLD) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
lockedDate | ΣI | 0..1 | date | Fixed date for references with no specified version (transitive) |
inactive | ΣI | 0..1 | boolean | Whether inactive codes are in the value set |
include | ΣI | 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 | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
system | ΣI | 0..1 | uri | The system the codes come from |
version | ΣI | 0..1 | string | Specific version of the code system referred to |
concept | I | 0..* | BackboneElement | A concept defined in the system |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | I | 1..1 | code | Code or expression from system |
display | I | 0..1 | string | Text to display for this code for this value set in this valueset |
designation | I | 0..* | BackboneElement | Additional representations for this concept |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
language | I | 0..1 | code | Human language of the designation Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
use | I | 0..1 | Coding | Types of uses of designations Binding: DesignationUse (extensible) |
value | I | 1..1 | string | The text value for this designation |
filter | ΣI | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
property | ΣI | 1..1 | code | A property/filter defined by the code system |
op | ΣI | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists Binding: FilterOperator (required) |
value | ΣI | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists |
valueSet | ΣI | 0..* | canonical(ValueSet) | Select the contents included in this value set |
exclude | I | 0..* | Unknown reference to #ValueSet.compose.include Explicitly exclude codes from a code system or other value sets | |
expansion | I | 0..1 | BackboneElement | Used when the value set is "expanded" |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
identifier | I | 0..1 | uri | Identifies the value set expansion (business identifier) |
timestamp | I | 1..1 | dateTime | Time ValueSet expansion happened |
total | I | 0..1 | integer | Total number of codes in the expansion |
offset | I | 0..1 | integer | Offset at which this resource starts |
parameter | I | 0..* | BackboneElement | Parameter that controlled the expansion process |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | I | 1..1 | string | Name as assigned by the client or server |
value[x] | I | 0..1 | Value of the named parameter | |
valueString | string | |||
valueBoolean | boolean | |||
valueInteger | integer | |||
valueDecimal | decimal | |||
valueUri | uri | |||
valueCode | code | |||
valueDateTime | dateTime | |||
contains | I | 0..* | BackboneElement | Codes in the value set vsd-6: SHALL have a code or a display vsd-9: Must have a code if not abstract vsd-10: Must have a system if a code is present |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
system | I | 0..1 | uri | System value for the code |
abstract | I | 0..1 | boolean | If user cannot select this entry |
inactive | I | 0..1 | boolean | If concept is inactive in the code system |
version | I | 0..1 | string | Version in which this code/display is defined |
code | I | 0..1 | code | Code - if blank, this is not a selectable code |
display | I | 0..1 | string | User display for the concept |
designation | I | 0..* | Unknown reference to #ValueSet.compose.include.concept.designation Additional representations for this item | |
contains | I | 0..* | Unknown reference to #ValueSet.expansion.contains Codes contained under this entry | |
Documentation for this format |
Differential View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ValueSet | 0..* | ValueSet | ||
extension | 1..* | Extension | Slice: Unordered, Open by value:url | |
valueset-steward | S | 1..1 | ContactDetail | Value set steward URL: http://hl7.org/fhir/StructureDefinition/valueset-steward |
valueset-author | S | 1..1 | ContactDetail | Value set author URL: http://hl7.org/fhir/StructureDefinition/valueset-author |
identifier | S | 1..* | Identifier | RCTC value set OID |
name | S | 1..1 | string | |
title | S | 1..1 | string | RCTC value set name |
status | S | 1..1 | code | RCTC value set definition version |
description | S | 1..1 | markdown | RCTC value set description |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ValueSet | I | 0..* | ValueSet | A set of codes drawn from one or more code systems |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 1..* | Extension | Extension Slice: Unordered, Open by value:url |
valueset-steward | SI | 1..1 | ContactDetail | Value set steward URL: http://hl7.org/fhir/StructureDefinition/valueset-steward |
valueset-author | SI | 1..1 | ContactDetail | Value set author URL: http://hl7.org/fhir/StructureDefinition/valueset-author |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
url | ΣI | 0..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) |
identifier | SΣI | 1..* | Identifier | RCTC value set OID |
version | ΣI | 0..1 | string | Business version of the value set |
name | SΣI | 1..1 | string | Name for this value set (computer friendly) |
title | SΣI | 1..1 | string | RCTC value set name |
status | ?!SΣI | 1..1 | code | RCTC value set definition version Binding: PublicationStatus (required) |
experimental | ΣI | 0..1 | boolean | For testing purposes, not real usage |
date | ΣI | 0..1 | dateTime | Date last changed |
publisher | ΣI | 0..1 | string | Name of the publisher (organization or individual) |
contact | ΣI | 0..* | ContactDetail | Contact details for the publisher |
description | SI | 1..1 | markdown | RCTC value set description |
useContext | ΣI | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | ΣI | 0..* | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: Jurisdiction ValueSet (extensible) |
immutable | ΣI | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur |
purpose | I | 0..1 | markdown | Why this value set is defined |
copyright | I | 0..1 | markdown | Use and/or publishing restrictions |
compose | I | 0..1 | BackboneElement | Content logical definition of the value set (CLD) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
lockedDate | ΣI | 0..1 | date | Fixed date for references with no specified version (transitive) |
inactive | ΣI | 0..1 | boolean | Whether inactive codes are in the value set |
include | ΣI | 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 | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
system | ΣI | 0..1 | uri | The system the codes come from |
version | ΣI | 0..1 | string | Specific version of the code system referred to |
concept | I | 0..* | BackboneElement | A concept defined in the system |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | I | 1..1 | code | Code or expression from system |
display | I | 0..1 | string | Text to display for this code for this value set in this valueset |
designation | I | 0..* | BackboneElement | Additional representations for this concept |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
language | I | 0..1 | code | Human language of the designation Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
use | I | 0..1 | Coding | Types of uses of designations Binding: DesignationUse (extensible) |
value | I | 1..1 | string | The text value for this designation |
filter | ΣI | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
property | ΣI | 1..1 | code | A property/filter defined by the code system |
op | ΣI | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists Binding: FilterOperator (required) |
value | ΣI | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists |
valueSet | ΣI | 0..* | canonical(ValueSet) | Select the contents included in this value set |
exclude | I | 0..* | Unknown reference to #ValueSet.compose.include Explicitly exclude codes from a code system or other value sets | |
expansion | I | 0..1 | BackboneElement | Used when the value set is "expanded" |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
identifier | I | 0..1 | uri | Identifies the value set expansion (business identifier) |
timestamp | I | 1..1 | dateTime | Time ValueSet expansion happened |
total | I | 0..1 | integer | Total number of codes in the expansion |
offset | I | 0..1 | integer | Offset at which this resource starts |
parameter | I | 0..* | BackboneElement | Parameter that controlled the expansion process |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | I | 1..1 | string | Name as assigned by the client or server |
value[x] | I | 0..1 | Value of the named parameter | |
valueString | string | |||
valueBoolean | boolean | |||
valueInteger | integer | |||
valueDecimal | decimal | |||
valueUri | uri | |||
valueCode | code | |||
valueDateTime | dateTime | |||
contains | I | 0..* | BackboneElement | Codes in the value set vsd-6: SHALL have a code or a display vsd-9: Must have a code if not abstract vsd-10: Must have a system if a code is present |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
system | I | 0..1 | uri | System value for the code |
abstract | I | 0..1 | boolean | If user cannot select this entry |
inactive | I | 0..1 | boolean | If concept is inactive in the code system |
version | I | 0..1 | string | Version in which this code/display is defined |
code | I | 0..1 | code | Code - if blank, this is not a selectable code |
display | I | 0..1 | string | User display for the concept |
designation | I | 0..* | Unknown reference to #ValueSet.compose.include.concept.designation Additional representations for this item | |
contains | I | 0..* | Unknown reference to #ValueSet.expansion.contains Codes contained under this entry | |
Documentation for this format |
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron