STU 3 Ballot
FoundationThis page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3
StructureDefinition for UsageContext
{
"resourceType": "StructureDefinition",
"id": "UsageContext",
"meta": {
"lastUpdated": "2016-08-11T17:02:54.322+10:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/UsageContext",
"name": "UsageContext",
"status": "draft",
"publisher": "HL7 FHIR Standard",
"contact": [
{
"telecom": [
{
"system": "other",
"value": "http://hl7.org/fhir"
}
]
}
],
"date": "2016-08-11T17:02:54+10:00",
"description": "Base StructureDefinition for UsageContext Type",
"requirements": "Consumers of the module must be able to determine the intended applicability for the module. Ideally, this information would be used programmatically to determine when and how it should be incorporated or exposed.",
"fhirVersion": "1.6.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"type": "UsageContext",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element",
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "UsageContext",
"path": "UsageContext",
"short": "Describes the context of use for a module",
"definition": "Specifies clinical metadata that can be used to retrieve, index and/or categorize the knowledge 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).",
"comments": "When multiple applicability attributes are specified, this means that all the attributes are applicable to this context. For example, if a gender and age group is specified, a patient must match the specified gender and age group for the asset to be considered applicable.",
"min": 0,
"max": "*",
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "children().count() > id.count()",
"xpath": "@value|f:*|h:div"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "UsageContext.id",
"path": "UsageContext.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "UsageContext.extension",
"path": "UsageContext.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "UsageContext.patientGender",
"path": "UsageContext.patientGender",
"short": "Patient gender",
"definition": "The gender of the patient. For this item type, use HL7 administrative gender codes (OID: 2.16.840.1.113883.1.11.1).",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "preferred",
"description": "The gender of a person used for administrative purposes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-AdministrativeGender"
}
}
},
{
"id": "UsageContext.patientAgeGroup",
"path": "UsageContext.patientAgeGroup",
"short": "Demographic category",
"definition": "A patient demographic category for which this artifact is applicable. Allows specification of age groups using coded values originating from the MeSH Code system (OID: 2.16.840.1.113883.6.177). More specifically, only codes from the AgeGroupObservationValue value set are valid for this field [2.16.840.1.113883.11.75].",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true
},
{
"id": "UsageContext.clinicalFocus",
"path": "UsageContext.clinicalFocus",
"short": "Clinical concepts addressed",
"definition": "The clinical concept(s) addressed by the artifact. For example, disease, diagnostic test interpretation, medication ordering. Please refer to the implementation guide on which code system and codes to use.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true
},
{
"id": "UsageContext.targetUser",
"path": "UsageContext.targetUser",
"short": "Target user type",
"definition": "The user types to which an artifact is targeted. For example, PCP, Patient, Cardiologist, Behavioral Professional, Oral Health Professional, Prescriber, etc... taken from the NUCC Health Care provider taxonomyCode system (OID: 2.16.840.1.113883.6.101).",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true
},
{
"id": "UsageContext.workflowSetting",
"path": "UsageContext.workflowSetting",
"short": "Workflow setting",
"definition": "The settings in which the artifact is intended for use. For example, admission, pre-op, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true
},
{
"id": "UsageContext.workflowTask",
"path": "UsageContext.workflowTask",
"short": "Clinical task context",
"definition": "The context for the clinical task(s) represented by this artifact. Can be any task context represented by the HL7 ActTaskCode value set (OID: 2.16.840.1.113883.1.11.19846). General categories include: order entry, patient documentation and patient information review.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true
},
{
"id": "UsageContext.clinicalVenue",
"path": "UsageContext.clinicalVenue",
"short": "Applicable venue",
"definition": "The venue in which an artifact could be used. For example, Outpatient, Inpatient, Home, Nursing home. The code value may originate from either the HL7 ActEncounter (OID: 2.16.840.1.113883.1.11.13955) or NUCC non-individual provider codes OID: 2.16.840.1.113883.1.11.19465.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "preferred",
"description": "The clinical venue in which an encounter occurs",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-ActEncounterCode"
}
}
},
{
"id": "UsageContext.jurisdiction",
"path": "UsageContext.jurisdiction",
"short": "Intended jurisdiction",
"definition": "The jurisdiction in which the artifact is intended to be used.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true
}
]
},
"differential": {
"element": [
{
"id": "UsageContext",
"path": "UsageContext",
"short": "Describes the context of use for a module",
"definition": "Specifies clinical metadata that can be used to retrieve, index and/or categorize the knowledge 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).",
"comments": "When multiple applicability attributes are specified, this means that all the attributes are applicable to this context. For example, if a gender and age group is specified, a patient must match the specified gender and age group for the asset to be considered applicable.",
"min": 0,
"max": "*"
},
{
"id": "UsageContext.patientGender",
"path": "UsageContext.patientGender",
"short": "Patient gender",
"definition": "The gender of the patient. For this item type, use HL7 administrative gender codes (OID: 2.16.840.1.113883.1.11.1).",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "preferred",
"description": "The gender of a person used for administrative purposes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-AdministrativeGender"
}
}
},
{
"id": "UsageContext.patientAgeGroup",
"path": "UsageContext.patientAgeGroup",
"short": "Demographic category",
"definition": "A patient demographic category for which this artifact is applicable. Allows specification of age groups using coded values originating from the MeSH Code system (OID: 2.16.840.1.113883.6.177). More specifically, only codes from the AgeGroupObservationValue value set are valid for this field [2.16.840.1.113883.11.75].",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true
},
{
"id": "UsageContext.clinicalFocus",
"path": "UsageContext.clinicalFocus",
"short": "Clinical concepts addressed",
"definition": "The clinical concept(s) addressed by the artifact. For example, disease, diagnostic test interpretation, medication ordering. Please refer to the implementation guide on which code system and codes to use.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true
},
{
"id": "UsageContext.targetUser",
"path": "UsageContext.targetUser",
"short": "Target user type",
"definition": "The user types to which an artifact is targeted. For example, PCP, Patient, Cardiologist, Behavioral Professional, Oral Health Professional, Prescriber, etc... taken from the NUCC Health Care provider taxonomyCode system (OID: 2.16.840.1.113883.6.101).",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true
},
{
"id": "UsageContext.workflowSetting",
"path": "UsageContext.workflowSetting",
"short": "Workflow setting",
"definition": "The settings in which the artifact is intended for use. For example, admission, pre-op, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true
},
{
"id": "UsageContext.workflowTask",
"path": "UsageContext.workflowTask",
"short": "Clinical task context",
"definition": "The context for the clinical task(s) represented by this artifact. Can be any task context represented by the HL7 ActTaskCode value set (OID: 2.16.840.1.113883.1.11.19846). General categories include: order entry, patient documentation and patient information review.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true
},
{
"id": "UsageContext.clinicalVenue",
"path": "UsageContext.clinicalVenue",
"short": "Applicable venue",
"definition": "The venue in which an artifact could be used. For example, Outpatient, Inpatient, Home, Nursing home. The code value may originate from either the HL7 ActEncounter (OID: 2.16.840.1.113883.1.11.13955) or NUCC non-individual provider codes OID: 2.16.840.1.113883.1.11.19465.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "preferred",
"description": "The clinical venue in which an encounter occurs",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-ActEncounterCode"
}
}
},
{
"id": "UsageContext.jurisdiction",
"path": "UsageContext.jurisdiction",
"short": "Intended jurisdiction",
"definition": "The jurisdiction in which the artifact is intended to be used.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
© HL7.org 2011+. FHIR STU3 Ballot (v1.6.0-9663) generated on Thu, Aug 11, 2016 17:06+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Compare to DSTU2 |
|
Propose a change