This page is part of the Structured Data Capture FHIR IG (v2.7.0: STU 3 Ballot 2) based on FHIR R4. The current version which supercedes this version is 3.0.0. For a full list of available versions, see the Directory of published versions
Definitions for the sdc-usagecontext Profile.
1. UsageContext | |
Definition | Specifies clinical/business/etc. metadata that can be used to retrieve, index and/or categorize an artifact. This metadata can either be specific to the applicable population (e.g., age category, DRG) or the specific context of care (e.g., venue, care setting, provider of care). |
Control | 0..* This element is affected by the following invariants: ele-1 |
Must Support | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) sdc-uc-1: If code is gender, focus, user, venue or species, value must be CodeableConcept. If code is age, value must be Range. If code is workflow, task or program, value must be CodeableConcept or Reference (: code.system!='http://terminology.hl7.org/CodeSystem/usage-context-type' or (((code.code='gender' or code.code='focus' or code.code='user' or code.code='venue' or code.code='species') implies value.exists() and value is CodeableConcept) and (code.code='age' implies value.exists() and value is Range) ((code.code='workflow' or code.code='task' or code.code='program') implies (value.exists() and (value is CodeableConcept or value is Reference))))) |
2. UsageContext.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
3. UsageContext.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
4. UsageContext.code | |
Definition | A code that identifies the type of context being specified by this usage context. |
Control | 1..1 |
Binding | A code that specifies a type of context being specified by a usage context. The codes SHALL be taken from UsageContextType; other codes may be used where these codes are not suitable |
Type | Coding |
Must Support | true |
5. UsageContext.value[x] | |
Definition | A value that defines the context specified in this context of use. The interpretation of the value is defined by the code. |
Control | 1..1 |
Binding | A code that defines the specific value for the context being specified. For example codes, see Context of Use ValueSet |
Type | Choice of: CodeableConcept, Quantity, Range, Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
6. UsageContext.value[x] | |
Definition | A value that defines the context specified in this context of use. The interpretation of the value is defined by the code. |
Control | 1..1 |
Binding | A code that defines the specific value for the context being specified. For example codes, see Context of Use ValueSet |
Type | Coding |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
7. UsageContext.value[x].id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
8. UsageContext.value[x].extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
9. UsageContext.value[x].system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 0..1 |
Type | uri |
Must Support | true |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
10. UsageContext.value[x].version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
11. UsageContext.value[x].code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 0..1 |
Type | code |
Must Support | true |
Requirements | Need to refer to a particular code in the system. |
12. UsageContext.value[x].display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 0..1 |
Type | string |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
13. UsageContext.value[x].userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Control | 0..1 |
Type | boolean |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
14. UsageContext.value[x] | |
Definition | A value that defines the context specified in this context of use. The interpretation of the value is defined by the code. |
Control | 1..1 |
Binding | A code that defines the specific value for the context being specified. For example codes, see Context of Use ValueSet |
Type | Range |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
15. UsageContext.value[x].id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
16. UsageContext.value[x].extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
17. UsageContext.value[x].low | |
Definition | The low limit. The boundary is inclusive. |
Control | 0..1 |
Type | Quantity(SimpleQuantity) |
Must Support | true |
Comments | If the low element is missing, the low boundary is not known. |
18. UsageContext.value[x].high | |
Definition | The high limit. The boundary is inclusive. |
Control | 0..1 |
Type | Quantity(SimpleQuantity) |
Must Support | true |
Comments | If the high element is missing, the high boundary is not known. |