Extensions for Using Data Elements from FHIR STU3 in FHIR R4B - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/3.0/StructureDefinition/profile-ValueSet | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R3_ValueSet_R4B | ||
This cross-version profile allows STU3 ValueSet content to be represented via FHIR R4B ValueSet resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | ValueSet(4.3.0) | A set of codes drawn from one or more code systems Constraints: vsd-0 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() ![]() |
0..1 | boolean | STU3: Whether this is intended to be used with an extensible binding (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ValueSet.extensible Constraints: ext-1 | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ValueSet.status | Base | required | PublicationStatus | 📍4.3.0 | FHIR Std. |
| 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.exists() and ('#'+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(uri) = '#').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 | ValueSet.implicitRules, ValueSet.extension, ValueSet.extension:extensible, ValueSet.modifierExtension, ValueSet.status | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ValueSet.extension, ValueSet.extension:extensible, ValueSet.modifierExtension | 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.exists() implies name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
This structure is derived from ValueSet
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | ValueSet(4.3.0) | A set of codes drawn from one or more code systems Constraints: vsd-0 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | STU3: meta additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ValueSet.meta Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() |
0..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 | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | STU3: text additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ValueSet.text Constraints: ext-1 | |||||
![]() ![]() ![]() |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required) | |||||
![]() ![]() ![]() |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
![]() ![]() |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..1 | boolean | STU3: Whether this is intended to be used with an extensible binding (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ValueSet.extensible Constraints: ext-1 | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
Σ | 0..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) | ||||
![]() ![]() |
Σ | 0..* | Identifier | Additional identifier for the value set (business identifier) | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | Identifier | STU3: Additional identifier for the value set additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ValueSet.identifier Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
Σ | 0..1 | string | Business version of the value set | ||||
![]() ![]() |
Σ | 0..1 | string | Name for this value set (computer friendly) | ||||
![]() ![]() |
Σ | 0..1 | string | Name for this value set (human friendly) | ||||
![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
![]() ![]() |
Σ | 0..1 | dateTime | Date last changed | ||||
![]() ![]() |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | ContactDetail | STU3: contact additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ValueSet.contact Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 0..1 | string | Name of an individual to contact | ||||
![]() ![]() ![]() |
Σ | 0..* | ContactPoint | Contact details for individual or organization | ||||
![]() ![]() |
0..1 | markdown | Natural language description of the value set | |||||
![]() ![]() |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | UsageContext | STU3: Context the content is intended to support additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ValueSet.useContext Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible) | ||||
![]() ![]() ![]() |
Σ | 1..1 | Value that defines the context Binding: Context of Use ValueSet (example) | |||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() |
Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) | |||||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() |
Σ | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur | ||||
![]() ![]() |
0..1 | markdown | Why this value set is defined | |||||
![]() ![]() |
0..1 | markdown | Use and/or publishing restrictions | |||||
![]() ![]() |
0..1 | BackboneElement | Content logical definition of the value set (CLD) | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
Σ | 0..1 | date | Fixed date for references with no specified version (transitive) | ||||
![]() ![]() ![]() |
Σ | 0..1 | boolean | Whether inactive codes are in the value set | ||||
![]() ![]() ![]() |
ΣC | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) Constraints: vsd-1, vsd-2, vsd-3 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | uri | The system the codes come from | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Specific version of the code system referred to | ||||
![]() ![]() ![]() ![]() |
C | 0..* | BackboneElement | A concept defined in the system | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Code or expression from system | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Text to display for this code for this value set in this valueset | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | BackboneElement | Additional representations for this concept | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Human language of the designation Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Types of uses of designations Binding: DesignationUse (extensible): Details of how a designation would be used. | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | The text value for this designation | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | A property/filter defined by the code system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | canonical(ValueSet) | Select the contents included in this value set | ||||
![]() ![]() ![]() |
C | 0..* | See include (ValueSet) | Explicitly exclude codes from a code system or other value sets | ||||
![]() ![]() |
0..1 | BackboneElement | Used when the value set is "expanded" | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
0..1 | uri | Identifies the value set expansion (business identifier) | |||||
![]() ![]() ![]() |
1..1 | dateTime | Time ValueSet expansion happened | |||||
![]() ![]() ![]() |
0..1 | integer | Total number of codes in the expansion | |||||
![]() ![]() ![]() |
0..1 | integer | Offset at which this resource starts | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Parameter that controlled the expansion process | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
1..1 | string | Name as assigned by the client or server | |||||
![]() ![]() ![]() ![]() |
0..1 | Value of the named parameter | ||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() ![]() |
decimal | |||||||
![]() ![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() ![]() ![]() |
code | |||||||
![]() ![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | Codes in the value set Constraints: vsd-6, vsd-9, vsd-10 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | uri | System value for the code | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | If user cannot select this entry | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | If concept is inactive in the code system | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Version in which this code/display is defined | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | code | Code - if blank, this is not a selectable code | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | string | User display for the concept | ||||
![]() ![]() ![]() ![]() |
0..* | See designation (ValueSet) | Additional representations for this item | |||||
![]() ![]() ![]() ![]() |
0..* | See contains (ValueSet) | Codes contained under this entry | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ValueSet.meta.security | Base | extensible | SecurityLabels | 📍4.3.0 | FHIR Std. |
| ValueSet.meta.tag | Base | example | Common Tags | 📍4.3.0 | FHIR Std. |
| ValueSet.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| ValueSet.text.status | Base | required | NarrativeStatus | 📍4.3.0 | FHIR Std. |
| ValueSet.identifier.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| ValueSet.identifier.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| ValueSet.status | Base | required | PublicationStatus | 📍4.3.0 | FHIR Std. |
| ValueSet.useContext.code | Base | extensible | UsageContextType | 📍4.3.0 | FHIR Std. |
| ValueSet.useContext.value[x] | Base | example | ConformanceUseContext | 📍4.3.0 | FHIR Std. |
| ValueSet.jurisdiction | Base | extensible | Jurisdiction | 📍4.3.0 | FHIR Std. |
| ValueSet.compose.include.concept.designation.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| ValueSet.compose.include.concept.designation.use | Base | extensible | Designation Use | 📍4.3.0 | FHIR Std. |
| ValueSet.compose.include.filter.op | Base | required | FilterOperator | 📍4.3.0 | FHIR Std. |
| 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.exists() and ('#'+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(uri) = '#').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()
|
| dom-r4b | warning | ValueSet.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | ValueSet.meta, ValueSet.meta.extension, ValueSet.meta.extension:meta, ValueSet.meta.versionId, ValueSet.meta.lastUpdated, ValueSet.meta.source, ValueSet.meta.profile, ValueSet.meta.security, ValueSet.meta.tag, ValueSet.implicitRules, ValueSet.language, ValueSet.text, ValueSet.text.extension, ValueSet.text.extension:text, ValueSet.text.status, ValueSet.text.div, ValueSet.extension, ValueSet.extension:extensible, ValueSet.modifierExtension, ValueSet.url, ValueSet.identifier, ValueSet.identifier.extension, ValueSet.identifier.extension:identifier, ValueSet.identifier.use, ValueSet.identifier.type, ValueSet.identifier.system, ValueSet.identifier.value, ValueSet.identifier.period, ValueSet.identifier.assigner, ValueSet.version, ValueSet.name, ValueSet.title, ValueSet.status, ValueSet.experimental, ValueSet.date, ValueSet.publisher, ValueSet.contact, ValueSet.contact.extension, ValueSet.contact.extension:contact, ValueSet.contact.name, ValueSet.contact.telecom, ValueSet.description, ValueSet.useContext, ValueSet.useContext.extension, ValueSet.useContext.extension:useContext, ValueSet.useContext.code, ValueSet.useContext.value[x], ValueSet.jurisdiction, ValueSet.immutable, ValueSet.purpose, ValueSet.copyright, ValueSet.compose, ValueSet.compose.extension, ValueSet.compose.modifierExtension, ValueSet.compose.lockedDate, ValueSet.compose.inactive, ValueSet.compose.include, ValueSet.compose.include.extension, ValueSet.compose.include.modifierExtension, ValueSet.compose.include.system, ValueSet.compose.include.version, ValueSet.compose.include.concept, ValueSet.compose.include.concept.extension, ValueSet.compose.include.concept.modifierExtension, ValueSet.compose.include.concept.code, ValueSet.compose.include.concept.display, ValueSet.compose.include.concept.designation, ValueSet.compose.include.concept.designation.extension, ValueSet.compose.include.concept.designation.modifierExtension, ValueSet.compose.include.concept.designation.language, ValueSet.compose.include.concept.designation.use, ValueSet.compose.include.concept.designation.value, ValueSet.compose.include.filter, ValueSet.compose.include.filter.extension, ValueSet.compose.include.filter.modifierExtension, ValueSet.compose.include.filter.property, ValueSet.compose.include.filter.op, ValueSet.compose.include.filter.value, ValueSet.compose.include.valueSet, ValueSet.compose.exclude, ValueSet.expansion, ValueSet.expansion.extension, ValueSet.expansion.modifierExtension, ValueSet.expansion.identifier, ValueSet.expansion.timestamp, ValueSet.expansion.total, ValueSet.expansion.offset, ValueSet.expansion.parameter, ValueSet.expansion.parameter.extension, ValueSet.expansion.parameter.modifierExtension, ValueSet.expansion.parameter.name, ValueSet.expansion.parameter.value[x], ValueSet.expansion.contains, ValueSet.expansion.contains.extension, ValueSet.expansion.contains.modifierExtension, ValueSet.expansion.contains.system, ValueSet.expansion.contains.abstract, ValueSet.expansion.contains.inactive, ValueSet.expansion.contains.version, ValueSet.expansion.contains.code, ValueSet.expansion.contains.display, ValueSet.expansion.contains.designation, ValueSet.expansion.contains.contains | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ValueSet.meta.extension, ValueSet.meta.extension:meta, ValueSet.text.extension, ValueSet.text.extension:text, ValueSet.extension, ValueSet.extension:extensible, ValueSet.modifierExtension, ValueSet.identifier.extension, ValueSet.identifier.extension:identifier, ValueSet.contact.extension, ValueSet.contact.extension:contact, ValueSet.useContext.extension, ValueSet.useContext.extension:useContext, ValueSet.compose.extension, ValueSet.compose.modifierExtension, ValueSet.compose.include.extension, ValueSet.compose.include.modifierExtension, ValueSet.compose.include.concept.extension, ValueSet.compose.include.concept.modifierExtension, ValueSet.compose.include.concept.designation.extension, ValueSet.compose.include.concept.designation.modifierExtension, ValueSet.compose.include.filter.extension, ValueSet.compose.include.filter.modifierExtension, ValueSet.expansion.extension, ValueSet.expansion.modifierExtension, ValueSet.expansion.parameter.extension, ValueSet.expansion.parameter.modifierExtension, ValueSet.expansion.contains.extension, ValueSet.expansion.contains.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| txt-1 | error | ValueSet.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | ValueSet.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
| vsd-0 | warning | ValueSet | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.exists() implies name.exists() implies 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
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | ValueSet(4.3.0) | A set of codes drawn from one or more code systems Constraints: vsd-0 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() ![]() |
0..1 | boolean | STU3: Whether this is intended to be used with an extensible binding (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ValueSet.extensible Constraints: ext-1 | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ValueSet.status | Base | required | PublicationStatus | 📍4.3.0 | FHIR Std. |
| 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.exists() and ('#'+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(uri) = '#').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 | ValueSet.implicitRules, ValueSet.extension, ValueSet.extension:extensible, ValueSet.modifierExtension, ValueSet.status | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ValueSet.extension, ValueSet.extension:extensible, ValueSet.modifierExtension | 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.exists() implies name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
Differential View
This structure is derived from ValueSet
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | ValueSet(4.3.0) | A set of codes drawn from one or more code systems Constraints: vsd-0 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | STU3: meta additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ValueSet.meta Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() |
0..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 | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | STU3: text additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ValueSet.text Constraints: ext-1 | |||||
![]() ![]() ![]() |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required) | |||||
![]() ![]() ![]() |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
![]() ![]() |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..1 | boolean | STU3: Whether this is intended to be used with an extensible binding (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ValueSet.extensible Constraints: ext-1 | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
Σ | 0..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) | ||||
![]() ![]() |
Σ | 0..* | Identifier | Additional identifier for the value set (business identifier) | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | Identifier | STU3: Additional identifier for the value set additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ValueSet.identifier Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
Σ | 0..1 | string | Business version of the value set | ||||
![]() ![]() |
Σ | 0..1 | string | Name for this value set (computer friendly) | ||||
![]() ![]() |
Σ | 0..1 | string | Name for this value set (human friendly) | ||||
![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
![]() ![]() |
Σ | 0..1 | dateTime | Date last changed | ||||
![]() ![]() |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | ContactDetail | STU3: contact additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ValueSet.contact Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 0..1 | string | Name of an individual to contact | ||||
![]() ![]() ![]() |
Σ | 0..* | ContactPoint | Contact details for individual or organization | ||||
![]() ![]() |
0..1 | markdown | Natural language description of the value set | |||||
![]() ![]() |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | UsageContext | STU3: Context the content is intended to support additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ValueSet.useContext Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible) | ||||
![]() ![]() ![]() |
Σ | 1..1 | Value that defines the context Binding: Context of Use ValueSet (example) | |||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() |
Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) | |||||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() |
Σ | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur | ||||
![]() ![]() |
0..1 | markdown | Why this value set is defined | |||||
![]() ![]() |
0..1 | markdown | Use and/or publishing restrictions | |||||
![]() ![]() |
0..1 | BackboneElement | Content logical definition of the value set (CLD) | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
Σ | 0..1 | date | Fixed date for references with no specified version (transitive) | ||||
![]() ![]() ![]() |
Σ | 0..1 | boolean | Whether inactive codes are in the value set | ||||
![]() ![]() ![]() |
ΣC | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) Constraints: vsd-1, vsd-2, vsd-3 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | uri | The system the codes come from | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Specific version of the code system referred to | ||||
![]() ![]() ![]() ![]() |
C | 0..* | BackboneElement | A concept defined in the system | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Code or expression from system | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Text to display for this code for this value set in this valueset | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | BackboneElement | Additional representations for this concept | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Human language of the designation Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Types of uses of designations Binding: DesignationUse (extensible): Details of how a designation would be used. | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | The text value for this designation | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | A property/filter defined by the code system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | canonical(ValueSet) | Select the contents included in this value set | ||||
![]() ![]() ![]() |
C | 0..* | See include (ValueSet) | Explicitly exclude codes from a code system or other value sets | ||||
![]() ![]() |
0..1 | BackboneElement | Used when the value set is "expanded" | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
0..1 | uri | Identifies the value set expansion (business identifier) | |||||
![]() ![]() ![]() |
1..1 | dateTime | Time ValueSet expansion happened | |||||
![]() ![]() ![]() |
0..1 | integer | Total number of codes in the expansion | |||||
![]() ![]() ![]() |
0..1 | integer | Offset at which this resource starts | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Parameter that controlled the expansion process | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
1..1 | string | Name as assigned by the client or server | |||||
![]() ![]() ![]() ![]() |
0..1 | Value of the named parameter | ||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() ![]() |
decimal | |||||||
![]() ![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() ![]() ![]() |
code | |||||||
![]() ![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | Codes in the value set Constraints: vsd-6, vsd-9, vsd-10 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | uri | System value for the code | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | If user cannot select this entry | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | If concept is inactive in the code system | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Version in which this code/display is defined | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | code | Code - if blank, this is not a selectable code | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | string | User display for the concept | ||||
![]() ![]() ![]() ![]() |
0..* | See designation (ValueSet) | Additional representations for this item | |||||
![]() ![]() ![]() ![]() |
0..* | See contains (ValueSet) | Codes contained under this entry | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ValueSet.meta.security | Base | extensible | SecurityLabels | 📍4.3.0 | FHIR Std. |
| ValueSet.meta.tag | Base | example | Common Tags | 📍4.3.0 | FHIR Std. |
| ValueSet.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| ValueSet.text.status | Base | required | NarrativeStatus | 📍4.3.0 | FHIR Std. |
| ValueSet.identifier.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| ValueSet.identifier.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| ValueSet.status | Base | required | PublicationStatus | 📍4.3.0 | FHIR Std. |
| ValueSet.useContext.code | Base | extensible | UsageContextType | 📍4.3.0 | FHIR Std. |
| ValueSet.useContext.value[x] | Base | example | ConformanceUseContext | 📍4.3.0 | FHIR Std. |
| ValueSet.jurisdiction | Base | extensible | Jurisdiction | 📍4.3.0 | FHIR Std. |
| ValueSet.compose.include.concept.designation.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| ValueSet.compose.include.concept.designation.use | Base | extensible | Designation Use | 📍4.3.0 | FHIR Std. |
| ValueSet.compose.include.filter.op | Base | required | FilterOperator | 📍4.3.0 | FHIR Std. |
| 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.exists() and ('#'+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(uri) = '#').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()
|
| dom-r4b | warning | ValueSet.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | ValueSet.meta, ValueSet.meta.extension, ValueSet.meta.extension:meta, ValueSet.meta.versionId, ValueSet.meta.lastUpdated, ValueSet.meta.source, ValueSet.meta.profile, ValueSet.meta.security, ValueSet.meta.tag, ValueSet.implicitRules, ValueSet.language, ValueSet.text, ValueSet.text.extension, ValueSet.text.extension:text, ValueSet.text.status, ValueSet.text.div, ValueSet.extension, ValueSet.extension:extensible, ValueSet.modifierExtension, ValueSet.url, ValueSet.identifier, ValueSet.identifier.extension, ValueSet.identifier.extension:identifier, ValueSet.identifier.use, ValueSet.identifier.type, ValueSet.identifier.system, ValueSet.identifier.value, ValueSet.identifier.period, ValueSet.identifier.assigner, ValueSet.version, ValueSet.name, ValueSet.title, ValueSet.status, ValueSet.experimental, ValueSet.date, ValueSet.publisher, ValueSet.contact, ValueSet.contact.extension, ValueSet.contact.extension:contact, ValueSet.contact.name, ValueSet.contact.telecom, ValueSet.description, ValueSet.useContext, ValueSet.useContext.extension, ValueSet.useContext.extension:useContext, ValueSet.useContext.code, ValueSet.useContext.value[x], ValueSet.jurisdiction, ValueSet.immutable, ValueSet.purpose, ValueSet.copyright, ValueSet.compose, ValueSet.compose.extension, ValueSet.compose.modifierExtension, ValueSet.compose.lockedDate, ValueSet.compose.inactive, ValueSet.compose.include, ValueSet.compose.include.extension, ValueSet.compose.include.modifierExtension, ValueSet.compose.include.system, ValueSet.compose.include.version, ValueSet.compose.include.concept, ValueSet.compose.include.concept.extension, ValueSet.compose.include.concept.modifierExtension, ValueSet.compose.include.concept.code, ValueSet.compose.include.concept.display, ValueSet.compose.include.concept.designation, ValueSet.compose.include.concept.designation.extension, ValueSet.compose.include.concept.designation.modifierExtension, ValueSet.compose.include.concept.designation.language, ValueSet.compose.include.concept.designation.use, ValueSet.compose.include.concept.designation.value, ValueSet.compose.include.filter, ValueSet.compose.include.filter.extension, ValueSet.compose.include.filter.modifierExtension, ValueSet.compose.include.filter.property, ValueSet.compose.include.filter.op, ValueSet.compose.include.filter.value, ValueSet.compose.include.valueSet, ValueSet.compose.exclude, ValueSet.expansion, ValueSet.expansion.extension, ValueSet.expansion.modifierExtension, ValueSet.expansion.identifier, ValueSet.expansion.timestamp, ValueSet.expansion.total, ValueSet.expansion.offset, ValueSet.expansion.parameter, ValueSet.expansion.parameter.extension, ValueSet.expansion.parameter.modifierExtension, ValueSet.expansion.parameter.name, ValueSet.expansion.parameter.value[x], ValueSet.expansion.contains, ValueSet.expansion.contains.extension, ValueSet.expansion.contains.modifierExtension, ValueSet.expansion.contains.system, ValueSet.expansion.contains.abstract, ValueSet.expansion.contains.inactive, ValueSet.expansion.contains.version, ValueSet.expansion.contains.code, ValueSet.expansion.contains.display, ValueSet.expansion.contains.designation, ValueSet.expansion.contains.contains | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ValueSet.meta.extension, ValueSet.meta.extension:meta, ValueSet.text.extension, ValueSet.text.extension:text, ValueSet.extension, ValueSet.extension:extensible, ValueSet.modifierExtension, ValueSet.identifier.extension, ValueSet.identifier.extension:identifier, ValueSet.contact.extension, ValueSet.contact.extension:contact, ValueSet.useContext.extension, ValueSet.useContext.extension:useContext, ValueSet.compose.extension, ValueSet.compose.modifierExtension, ValueSet.compose.include.extension, ValueSet.compose.include.modifierExtension, ValueSet.compose.include.concept.extension, ValueSet.compose.include.concept.modifierExtension, ValueSet.compose.include.concept.designation.extension, ValueSet.compose.include.concept.designation.modifierExtension, ValueSet.compose.include.filter.extension, ValueSet.compose.include.filter.modifierExtension, ValueSet.expansion.extension, ValueSet.expansion.modifierExtension, ValueSet.expansion.parameter.extension, ValueSet.expansion.parameter.modifierExtension, ValueSet.expansion.contains.extension, ValueSet.expansion.contains.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| txt-1 | error | ValueSet.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | ValueSet.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
| vsd-0 | warning | ValueSet | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.exists() implies name.exists() implies 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
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron