This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Base Resources defined as profiles (implementation assistance, for for validation, derivation and product development)
{
"resourceType": "Bundle",
"title": "Resources as Profiles",
"id": "http://hl7.org/fhir/profile/resources",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/profiles-resources.xml"
}
],
"updated": "2014-09-30T18:09:12.096+10:00",
"entry": [
{
"title": "\"conformance-base\" - to help with system development",
"id": "http://hl7.org/fhir/conformance/conformance-base",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/conformance/conformance-base"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Conformance",
"text": {
"status": "generated",
"div": "<div><h2>Base FHIR Conformance Statement (Full)</h2><p>This is the base conformance statement for FHIR. It represents a server that provides the full set of functionality defined by FHIR. It is provided to use as a template for system designers to build their own conformance statements from</p><table><tr><td>Mode</td><td>server</td></tr><tr><td>Description</td><td>All the functionality defined in FHIR</td></tr><tr><td>Transaction</td><td>y</td></tr><tr><td>System History</td><td>y</td></tr><tr><td>System Search</td><td>y</td></tr></table><table><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th><b>Read</b></th><th><b>V-Read</b></th><th><b>Search</b></th><th><b>Update</b></th><th><b>Updates</b></th><th><b>Create</b></th><th><b>Delete</b></th><th><b>History</b></th></tr><tr><td>AdverseReaction</td><td><a href=\"http://hl7.org/fhir/AdverseReaction\">http://hl7.org/fhir/AdverseReaction</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Alert</td><td><a href=\"http://hl7.org/fhir/Alert\">http://hl7.org/fhir/Alert</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>AllergyIntolerance</td><td><a href=\"http://hl7.org/fhir/AllergyIntolerance\">http://hl7.org/fhir/AllergyIntolerance</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>CarePlan</td><td><a href=\"http://hl7.org/fhir/CarePlan\">http://hl7.org/fhir/CarePlan</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Composition</td><td><a href=\"http://hl7.org/fhir/Composition\">http://hl7.org/fhir/Composition</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>ConceptMap</td><td><a href=\"http://hl7.org/fhir/ConceptMap\">http://hl7.org/fhir/ConceptMap</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Condition</td><td><a href=\"http://hl7.org/fhir/Condition\">http://hl7.org/fhir/Condition</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Conformance</td><td><a href=\"http://hl7.org/fhir/Conformance\">http://hl7.org/fhir/Conformance</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Device</td><td><a href=\"http://hl7.org/fhir/Device\">http://hl7.org/fhir/Device</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>DeviceObservationReport</td><td><a href=\"http://hl7.org/fhir/DeviceObservationReport\">http://hl7.org/fhir/DeviceObservationReport</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>DiagnosticOrder</td><td><a href=\"http://hl7.org/fhir/DiagnosticOrder\">http://hl7.org/fhir/DiagnosticOrder</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>DiagnosticReport</td><td><a href=\"http://hl7.org/fhir/DiagnosticReport\">http://hl7.org/fhir/DiagnosticReport</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>DocumentManifest</td><td><a href=\"http://hl7.org/fhir/DocumentManifest\">http://hl7.org/fhir/DocumentManifest</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>DocumentReference</td><td><a href=\"http://hl7.org/fhir/DocumentReference\">http://hl7.org/fhir/DocumentReference</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Encounter</td><td><a href=\"http://hl7.org/fhir/Encounter\">http://hl7.org/fhir/Encounter</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>FamilyHistory</td><td><a href=\"http://hl7.org/fhir/FamilyHistory\">http://hl7.org/fhir/FamilyHistory</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Group</td><td><a href=\"http://hl7.org/fhir/Group\">http://hl7.org/fhir/Group</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>ImagingStudy</td><td><a href=\"http://hl7.org/fhir/ImagingStudy\">http://hl7.org/fhir/ImagingStudy</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Immunization</td><td><a href=\"http://hl7.org/fhir/Immunization\">http://hl7.org/fhir/Immunization</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>ImmunizationRecommendation</td><td><a href=\"http://hl7.org/fhir/ImmunizationRecommendation\">http://hl7.org/fhir/ImmunizationRecommendation</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>List</td><td><a href=\"http://hl7.org/fhir/List\">http://hl7.org/fhir/List</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Location</td><td><a href=\"http://hl7.org/fhir/Location\">http://hl7.org/fhir/Location</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Media</td><td><a href=\"http://hl7.org/fhir/Media\">http://hl7.org/fhir/Media</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Medication</td><td><a href=\"http://hl7.org/fhir/Medication\">http://hl7.org/fhir/Medication</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>MedicationAdministration</td><td><a href=\"http://hl7.org/fhir/MedicationAdministration\">http://hl7.org/fhir/MedicationAdministration</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>MedicationDispense</td><td><a href=\"http://hl7.org/fhir/MedicationDispense\">http://hl7.org/fhir/MedicationDispense</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>MedicationPrescription</td><td><a href=\"http://hl7.org/fhir/MedicationPrescription\">http://hl7.org/fhir/MedicationPrescription</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>MedicationStatement</td><td><a href=\"http://hl7.org/fhir/MedicationStatement\">http://hl7.org/fhir/MedicationStatement</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>MessageHeader</td><td><a href=\"http://hl7.org/fhir/MessageHeader\">http://hl7.org/fhir/MessageHeader</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Observation</td><td><a href=\"http://hl7.org/fhir/Observation\">http://hl7.org/fhir/Observation</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>OperationOutcome</td><td><a href=\"http://hl7.org/fhir/OperationOutcome\">http://hl7.org/fhir/OperationOutcome</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Order</td><td><a href=\"http://hl7.org/fhir/Order\">http://hl7.org/fhir/Order</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>OrderResponse</td><td><a href=\"http://hl7.org/fhir/OrderResponse\">http://hl7.org/fhir/OrderResponse</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Organization</td><td><a href=\"http://hl7.org/fhir/Organization\">http://hl7.org/fhir/Organization</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Other</td><td><a href=\"http://hl7.org/fhir/Other\">http://hl7.org/fhir/Other</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Patient</td><td><a href=\"http://hl7.org/fhir/Patient\">http://hl7.org/fhir/Patient</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Practitioner</td><td><a href=\"http://hl7.org/fhir/Practitioner\">http://hl7.org/fhir/Practitioner</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Procedure</td><td><a href=\"http://hl7.org/fhir/Procedure\">http://hl7.org/fhir/Procedure</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Profile</td><td><a href=\"http://hl7.org/fhir/Profile\">http://hl7.org/fhir/Profile</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Provenance</td><td><a href=\"http://hl7.org/fhir/Provenance\">http://hl7.org/fhir/Provenance</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Query</td><td><a href=\"http://hl7.org/fhir/Query\">http://hl7.org/fhir/Query</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Questionnaire</td><td><a href=\"http://hl7.org/fhir/Questionnaire\">http://hl7.org/fhir/Questionnaire</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>RelatedPerson</td><td><a href=\"http://hl7.org/fhir/RelatedPerson\">http://hl7.org/fhir/RelatedPerson</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>SecurityEvent</td><td><a href=\"http://hl7.org/fhir/SecurityEvent\">http://hl7.org/fhir/SecurityEvent</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Specimen</td><td><a href=\"http://hl7.org/fhir/Specimen\">http://hl7.org/fhir/Specimen</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Substance</td><td><a href=\"http://hl7.org/fhir/Substance\">http://hl7.org/fhir/Substance</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Supply</td><td><a href=\"http://hl7.org/fhir/Supply\">http://hl7.org/fhir/Supply</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>ValueSet</td><td><a href=\"http://hl7.org/fhir/ValueSet\">http://hl7.org/fhir/ValueSet</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr></table></div>"
},
"identifier": "http://hl7.org/fhir/conformance-base",
"version": "0.0.82.2943",
"name": "Base FHIR Conformance Statement (Full)",
"publisher": "FHIR Project Team",
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
],
"description": "This is the base conformance statement for FHIR. It represents a server that provides the full set of functionality defined by FHIR. It is provided to use as a template for system designers to build their own conformance statements from",
"status": "draft",
"date": "2014-09-30T18:08:29.499+10:00",
"fhirVersion": "0.0.82",
"acceptUnknown": false,
"format": [
"xml",
"json"
],
"rest": [
{
"mode": "server",
"documentation": "All the functionality defined in FHIR",
"resource": [
{
"type": "AdverseReaction",
"profile": {
"reference": "http://hl7.org/fhir/AdverseReaction"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "substance",
"definition": "http://hl7.org/fhir/profiles/AdverseReaction",
"type": "reference",
"documentation": "The name or code of the substance that produces the sensitivity"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/AdverseReaction",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/AdverseReaction",
"type": "reference",
"documentation": "The subject that the sensitivity is about"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/AdverseReaction",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/AdverseReaction",
"type": "date",
"documentation": "The date of the reaction"
},
{
"name": "symptom",
"definition": "http://hl7.org/fhir/profiles/AdverseReaction",
"type": "token",
"documentation": "One of the symptoms of the reaction"
}
]
},
{
"type": "Alert",
"profile": {
"reference": "http://hl7.org/fhir/Alert"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Alert",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/Alert",
"type": "reference",
"documentation": "The identity of a subject to list alerts for"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Alert",
"type": "token",
"documentation": "The language of the resource"
}
]
},
{
"type": "AllergyIntolerance",
"profile": {
"reference": "http://hl7.org/fhir/AllergyIntolerance"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "substance",
"definition": "http://hl7.org/fhir/profiles/AllergyIntolerance",
"type": "reference",
"documentation": "The name or code of the substance that produces the sensitivity"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/AllergyIntolerance",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/AllergyIntolerance",
"type": "token",
"documentation": "The status of the sensitivity"
},
{
"name": "recorder",
"definition": "http://hl7.org/fhir/profiles/AllergyIntolerance",
"type": "reference",
"documentation": "Who recorded the sensitivity"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/AllergyIntolerance",
"type": "reference",
"documentation": "The subject that the sensitivity is about"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/AllergyIntolerance",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/AllergyIntolerance",
"type": "date",
"documentation": "Recorded date/time."
},
{
"name": "type",
"definition": "http://hl7.org/fhir/profiles/AllergyIntolerance",
"type": "token",
"documentation": "The type of sensitivity"
}
]
},
{
"type": "CarePlan",
"profile": {
"reference": "http://hl7.org/fhir/CarePlan"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "activitycode",
"definition": "http://hl7.org/fhir/profiles/CarePlan",
"type": "token",
"documentation": "Detail type of activity"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/profiles/CarePlan",
"type": "reference",
"documentation": "Who care plan is for"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/CarePlan",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "condition",
"definition": "http://hl7.org/fhir/profiles/CarePlan",
"type": "reference",
"documentation": "Health issues this plan addresses"
},
{
"name": "activitydetail",
"definition": "http://hl7.org/fhir/profiles/CarePlan",
"type": "reference",
"documentation": "Activity details defined in specific resource"
},
{
"name": "activitydate",
"definition": "http://hl7.org/fhir/profiles/CarePlan",
"type": "date",
"documentation": "Specified date occurs within period specified by CarePlan.activity.timingSchedule"
},
{
"name": "participant",
"definition": "http://hl7.org/fhir/profiles/CarePlan",
"type": "reference",
"documentation": "Who is involved"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/CarePlan",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/CarePlan",
"type": "date",
"documentation": "Time period plan covers"
}
]
},
{
"type": "Composition",
"profile": {
"reference": "http://hl7.org/fhir/Composition"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "author",
"definition": "http://hl7.org/fhir/profiles/Composition",
"type": "reference",
"documentation": "Who and/or what authored the composition"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Composition",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "attester",
"definition": "http://hl7.org/fhir/profiles/Composition",
"type": "reference",
"documentation": "Who attested the composition"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/Composition",
"type": "reference",
"documentation": "Who and/or what the composition is about"
},
{
"name": "section-content",
"definition": "http://hl7.org/fhir/profiles/Composition",
"type": "reference",
"documentation": "The actual data for the section"
},
{
"name": "context",
"definition": "http://hl7.org/fhir/profiles/Composition",
"type": "token",
"documentation": "Code(s) that apply to the event being documented"
},
{
"name": "class",
"definition": "http://hl7.org/fhir/profiles/Composition",
"type": "token",
"documentation": "Categorization of Composition"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Composition",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "section-type",
"definition": "http://hl7.org/fhir/profiles/Composition",
"type": "token",
"documentation": "Classification of section (recommended)"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/Composition",
"type": "date",
"documentation": "Composition editing time"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/profiles/Composition",
"type": "token",
"documentation": "Kind of composition (LOINC if possible)"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/Composition",
"type": "token",
"documentation": "Logical identifier of composition (version-independent)"
}
]
},
{
"type": "ConceptMap",
"profile": {
"reference": "http://hl7.org/fhir/ConceptMap"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "dependson",
"definition": "http://hl7.org/fhir/profiles/ConceptMap",
"type": "token",
"documentation": "Reference to element/field/valueset provides the context"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/ConceptMap",
"type": "token",
"documentation": "Status of the concept map"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/ConceptMap",
"type": "date",
"documentation": "The concept map publication date"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/profiles/ConceptMap",
"type": "token",
"documentation": "The version identifier of the concept map"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/profiles/ConceptMap",
"type": "string",
"documentation": "Name of the publisher of the concept map"
},
{
"name": "product",
"definition": "http://hl7.org/fhir/profiles/ConceptMap",
"type": "token",
"documentation": "Reference to element/field/valueset provides the context"
},
{
"name": "system",
"definition": "http://hl7.org/fhir/profiles/ConceptMap",
"type": "token",
"documentation": "The system for any destination concepts mapped by this map"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/ConceptMap",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "source",
"definition": "http://hl7.org/fhir/profiles/ConceptMap",
"type": "reference",
"documentation": "The system for any concepts mapped by this concept map"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/profiles/ConceptMap",
"type": "string",
"documentation": "Text search in the description of the concept map"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/profiles/ConceptMap",
"type": "string",
"documentation": "Name of the concept map"
},
{
"name": "target",
"definition": "http://hl7.org/fhir/profiles/ConceptMap",
"type": "reference",
"documentation": "Provides context to the mappings"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/ConceptMap",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/ConceptMap",
"type": "token",
"documentation": "The identifier of the concept map"
}
]
},
{
"type": "Condition",
"profile": {
"reference": "http://hl7.org/fhir/Condition"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "asserter",
"definition": "http://hl7.org/fhir/profiles/Condition",
"type": "reference",
"documentation": "Person who asserts this condition"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/Condition",
"type": "token",
"documentation": "The status of the condition"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/profiles/Condition",
"type": "token",
"documentation": "Location - may include laterality"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/Condition",
"type": "reference",
"documentation": "Who has the condition?"
},
{
"name": "onset",
"definition": "http://hl7.org/fhir/profiles/Condition",
"type": "date",
"documentation": "When the Condition started (if started on a date)"
},
{
"name": "evidence",
"definition": "http://hl7.org/fhir/profiles/Condition",
"type": "token",
"documentation": "Manifestation/symptom"
},
{
"name": "severity",
"definition": "http://hl7.org/fhir/profiles/Condition",
"type": "token",
"documentation": "The severity of the condition"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/profiles/Condition",
"type": "token",
"documentation": "Code for the condition"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/profiles/Condition",
"type": "reference",
"documentation": "Encounter when condition first asserted"
},
{
"name": "date-asserted",
"definition": "http://hl7.org/fhir/profiles/Condition",
"type": "date",
"documentation": "When first detected/suspected/entered"
},
{
"name": "stage",
"definition": "http://hl7.org/fhir/profiles/Condition",
"type": "token",
"documentation": "Simple summary (disease specific)"
},
{
"name": "related-code",
"definition": "http://hl7.org/fhir/profiles/Condition",
"type": "token",
"documentation": "Relationship target by means of a predefined code"
},
{
"name": "category",
"definition": "http://hl7.org/fhir/profiles/Condition",
"type": "token",
"documentation": "The category of the condition"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Condition",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "related-item",
"definition": "http://hl7.org/fhir/profiles/Condition",
"type": "reference",
"documentation": "Relationship target resource"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Condition",
"type": "token",
"documentation": "The language of the resource"
}
]
},
{
"type": "Conformance",
"profile": {
"reference": "http://hl7.org/fhir/Conformance"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "token",
"documentation": "The current status of the conformance statement"
},
{
"name": "resource",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "token",
"documentation": "Name of a resource mentioned in a conformance statement"
},
{
"name": "security",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "token",
"documentation": "Information about security of implementation"
},
{
"name": "format",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "token",
"documentation": "formats supported (xml | json | mime type)"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "date",
"documentation": "The conformance statement publication date"
},
{
"name": "mode",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "token",
"documentation": "Mode - restful (server/client) or messaging (sender/receiver)"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "token",
"documentation": "The version identifier of the conformance statement"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "string",
"documentation": "Name of the publisher of the conformance statement"
},
{
"name": "software",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "string",
"documentation": "Part of a the name of a software application"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "string",
"documentation": "Text search in the description of the conformance statement"
},
{
"name": "event",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "token",
"documentation": "Event code in a conformance statement"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "string",
"documentation": "Name of the conformance statement"
},
{
"name": "supported-profile",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "reference",
"documentation": "Profiles supported by the system"
},
{
"name": "fhirversion",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "token",
"documentation": "The version of FHIR"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "token",
"documentation": "The identifier of the conformance statement"
},
{
"name": "profile",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "reference",
"documentation": "A profile id invoked in a conformance statement"
}
]
},
{
"type": "Device",
"profile": {
"reference": "http://hl7.org/fhir/Device"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "organization",
"definition": "http://hl7.org/fhir/profiles/Device",
"type": "reference",
"documentation": "The organization responsible for the device"
},
{
"name": "model",
"definition": "http://hl7.org/fhir/profiles/Device",
"type": "string",
"documentation": "The model of the device"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/profiles/Device",
"type": "reference",
"documentation": "Patient information, if the resource is affixed to a person"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Device",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/profiles/Device",
"type": "reference",
"documentation": "A location, where the resource is found"
},
{
"name": "manufacturer",
"definition": "http://hl7.org/fhir/profiles/Device",
"type": "string",
"documentation": "The manufacturer of the device"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Device",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "udi",
"definition": "http://hl7.org/fhir/profiles/Device",
"type": "string",
"documentation": "FDA Mandated Unique Device Identifier"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/profiles/Device",
"type": "token",
"documentation": "The type of the device"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/Device",
"type": "token",
"documentation": "Instance id from manufacturer, owner and others"
}
]
},
{
"type": "DeviceObservationReport",
"profile": {
"reference": "http://hl7.org/fhir/DeviceObservationReport"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "observation",
"definition": "http://hl7.org/fhir/profiles/DeviceObservationReport",
"type": "reference",
"documentation": "The data for the metric"
},
{
"name": "source",
"definition": "http://hl7.org/fhir/profiles/DeviceObservationReport",
"type": "reference",
"documentation": "Identifies/describes where the data came from"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/DeviceObservationReport",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/DeviceObservationReport",
"type": "reference",
"documentation": "Subject of the measurement"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/DeviceObservationReport",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/profiles/DeviceObservationReport",
"type": "token",
"documentation": "The compatment code"
},
{
"name": "channel",
"definition": "http://hl7.org/fhir/profiles/DeviceObservationReport",
"type": "token",
"documentation": "The channel code"
}
]
},
{
"type": "DiagnosticOrder",
"profile": {
"reference": "http://hl7.org/fhir/DiagnosticOrder"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "orderer",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "reference",
"documentation": "Who ordered the test"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "token",
"documentation": "requested | received | accepted | in progress | review | completed | suspended | rejected | failed"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "reference",
"documentation": "Who and/or what test is about"
},
{
"name": "item-status",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "token",
"documentation": "requested | received | accepted | in progress | review | completed | suspended | rejected | failed"
},
{
"name": "event-status",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "token",
"documentation": "requested | received | accepted | in progress | review | completed | suspended | rejected | failed"
},
{
"name": "actor",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "reference",
"documentation": "Who recorded or did this"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "token",
"documentation": "Code to indicate the item (test or panel) being ordered"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "reference",
"documentation": "The encounter that this diagnostic order is associated with"
},
{
"name": "item-past-status",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "token",
"documentation": "requested | received | accepted | in progress | review | completed | suspended | rejected | failed"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "bodysite",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "token",
"documentation": "Location of requested test (if applicable)"
},
{
"name": "item-date",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "date",
"documentation": "The date at which the event happened"
},
{
"name": "specimen",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "reference",
"documentation": "If the whole order relates to specific specimens"
},
{
"name": "event-status-date",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "composite",
"documentation": "A combination of past-status and date"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "event-date",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "date",
"documentation": "The date at which the event happened"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "token",
"documentation": "Identifiers assigned to this order"
},
{
"name": "item-status-date",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "composite",
"documentation": "A combination of item-past-status and item-date"
}
]
},
{
"type": "DiagnosticReport",
"profile": {
"reference": "http://hl7.org/fhir/DiagnosticReport"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "result",
"definition": "http://hl7.org/fhir/profiles/DiagnosticReport",
"type": "reference",
"documentation": "Link to an atomic result (observation resource)"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/DiagnosticReport",
"type": "token",
"documentation": "The status of the report"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/DiagnosticReport",
"type": "reference",
"documentation": "The subject of the report"
},
{
"name": "issued",
"definition": "http://hl7.org/fhir/profiles/DiagnosticReport",
"type": "date",
"documentation": "When the report was issued"
},
{
"name": "diagnosis",
"definition": "http://hl7.org/fhir/profiles/DiagnosticReport",
"type": "token",
"documentation": "A coded diagnosis on the report"
},
{
"name": "image",
"definition": "http://hl7.org/fhir/profiles/DiagnosticReport",
"type": "reference",
"documentation": "Reference to the image source"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/DiagnosticReport",
"type": "date",
"documentation": "The clinically relevant time of the report"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/DiagnosticReport",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "request",
"definition": "http://hl7.org/fhir/profiles/DiagnosticReport",
"type": "reference",
"documentation": "What was requested"
},
{
"name": "specimen",
"definition": "http://hl7.org/fhir/profiles/DiagnosticReport",
"type": "reference",
"documentation": "The specimen details"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/profiles/DiagnosticReport",
"type": "token",
"documentation": "The name of the report (e.g. the code for the report as a whole, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result)"
},
{
"name": "service",
"definition": "http://hl7.org/fhir/profiles/DiagnosticReport",
"type": "token",
"documentation": "Which diagnostic discipline/department created the report"
},
{
"name": "performer",
"definition": "http://hl7.org/fhir/profiles/DiagnosticReport",
"type": "reference",
"documentation": "Who was the source of the report (organization)"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/DiagnosticReport",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/DiagnosticReport",
"type": "token",
"documentation": "An identifier for the report"
}
]
},
{
"type": "DocumentManifest",
"profile": {
"reference": "http://hl7.org/fhir/DocumentManifest"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "supersedes",
"definition": "http://hl7.org/fhir/profiles/DocumentManifest",
"type": "reference",
"documentation": "If this document manifest replaces another"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/DocumentManifest",
"type": "token",
"documentation": "current | superceded | entered in error"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/DocumentManifest",
"type": "reference",
"documentation": "The subject of the set of documents"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/profiles/DocumentManifest",
"type": "token",
"documentation": "What kind of document set this is"
},
{
"name": "recipient",
"definition": "http://hl7.org/fhir/profiles/DocumentManifest",
"type": "reference",
"documentation": "Intended to get notified about this set of documents"
},
{
"name": "content",
"definition": "http://hl7.org/fhir/profiles/DocumentManifest",
"type": "reference",
"documentation": "Contents of this set of documents"
},
{
"name": "author",
"definition": "http://hl7.org/fhir/profiles/DocumentManifest",
"type": "reference",
"documentation": "Who and/or what authored the document"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/DocumentManifest",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "created",
"definition": "http://hl7.org/fhir/profiles/DocumentManifest",
"type": "date",
"documentation": "When this document manifest created"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/profiles/DocumentManifest",
"type": "string",
"documentation": "Human-readable description (title)"
},
{
"name": "confidentiality",
"definition": "http://hl7.org/fhir/profiles/DocumentManifest",
"type": "token",
"documentation": "Sensitivity of set of documents"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/DocumentManifest",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/DocumentManifest",
"type": "token",
"documentation": "Unique Identifier for the set of documents"
}
]
},
{
"type": "DocumentReference",
"profile": {
"reference": "http://hl7.org/fhir/DocumentReference"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "location",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "string",
"documentation": "Where to access the document"
},
{
"name": "indexed",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "date",
"documentation": "When this document reference created"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "token",
"documentation": "current | superceded | entered in error"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "reference",
"documentation": "Who|what is the subject of the document"
},
{
"name": "relatesto",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "reference",
"documentation": "Target of the relationship"
},
{
"name": "relation",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "token",
"documentation": "replaces | transforms | signs | appends"
},
{
"name": "class",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "token",
"documentation": "Categorization of Document"
},
{
"name": "format",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "token",
"documentation": "Format/content rules for the document"
},
{
"name": "period",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "date",
"documentation": "Time of service that is being documented"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "token",
"documentation": "What kind of document this is (LOINC if possible)"
},
{
"name": "authenticator",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "reference",
"documentation": "Who/What authenticated the document"
},
{
"name": "size",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "number",
"documentation": "Size of the document in bytes"
},
{
"name": "relationship",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "composite",
"documentation": "Combination of relation and relatesTo"
},
{
"name": "author",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "reference",
"documentation": "Who and/or what authored the document"
},
{
"name": "custodian",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "reference",
"documentation": "Org which maintains the document"
},
{
"name": "facility",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "token",
"documentation": "Kind of facility where patient was seen"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "created",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "date",
"documentation": "Document creation time"
},
{
"name": "event",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "token",
"documentation": "Main Clinical Acts Documented"
},
{
"name": "confidentiality",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "token",
"documentation": "Sensitivity of source document"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "string",
"documentation": "Human-readable description (title)"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "language",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "token",
"documentation": "The marked primary language for the document"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "token",
"documentation": "Master Version Specific Identifier"
}
]
},
{
"type": "Encounter",
"profile": {
"reference": "http://hl7.org/fhir/Encounter"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Encounter",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/profiles/Encounter",
"type": "reference",
"documentation": "Location the encounter takes place"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/Encounter",
"type": "token",
"documentation": "planned | in progress | onleave | finished | cancelled"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/Encounter",
"type": "reference",
"documentation": "The patient present at the encounter"
},
{
"name": "indication",
"definition": "http://hl7.org/fhir/profiles/Encounter",
"type": "reference",
"documentation": "Reason the encounter takes place (resource)"
},
{
"name": "length",
"definition": "http://hl7.org/fhir/profiles/Encounter",
"type": "number",
"documentation": "Length of encounter in days"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Encounter",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/Encounter",
"type": "date",
"documentation": "A date within the period the Encounter lasted"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/Encounter",
"type": "token",
"documentation": "Identifier(s) by which this encounter is known"
},
{
"name": "location-period",
"definition": "http://hl7.org/fhir/profiles/Encounter",
"type": "date",
"documentation": "Time period during which the patient was present at the location"
}
]
},
{
"type": "FamilyHistory",
"profile": {
"reference": "http://hl7.org/fhir/FamilyHistory"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/FamilyHistory",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/FamilyHistory",
"type": "reference",
"documentation": "The identity of a subject to list family history items for"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/FamilyHistory",
"type": "token",
"documentation": "The language of the resource"
}
]
},
{
"type": "Group",
"profile": {
"reference": "http://hl7.org/fhir/Group"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "member",
"definition": "http://hl7.org/fhir/profiles/Group",
"type": "reference",
"documentation": "Who is in group"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Group",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "characteristic-value",
"definition": "http://hl7.org/fhir/profiles/Group",
"type": "composite",
"documentation": "A composite of both characteristic and value"
},
{
"name": "value",
"definition": "http://hl7.org/fhir/profiles/Group",
"type": "token",
"documentation": "Value held by characteristic"
},
{
"name": "actual",
"definition": "http://hl7.org/fhir/profiles/Group",
"type": "token",
"documentation": "Descriptive or actual"
},
{
"name": "exclude",
"definition": "http://hl7.org/fhir/profiles/Group",
"type": "token",
"documentation": "Group includes or excludes"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Group",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/profiles/Group",
"type": "token",
"documentation": "The kind of resources contained"
},
{
"name": "characteristic",
"definition": "http://hl7.org/fhir/profiles/Group",
"type": "token",
"documentation": "Kind of characteristic"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/profiles/Group",
"type": "token",
"documentation": "The type of resources the group contains"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/Group",
"type": "token",
"documentation": "Unique id"
}
]
},
{
"type": "ImagingStudy",
"profile": {
"reference": "http://hl7.org/fhir/ImagingStudy"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "uid",
"definition": "http://hl7.org/fhir/profiles/ImagingStudy",
"type": "token",
"documentation": "Formal identifier for this instance (0008,0018)"
},
{
"name": "series",
"definition": "http://hl7.org/fhir/profiles/ImagingStudy",
"type": "token",
"documentation": "The series id for the image"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/ImagingStudy",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "bodysite",
"definition": "http://hl7.org/fhir/profiles/ImagingStudy",
"type": "token",
"documentation": "Body part examined (Map from 0018,0015)"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/ImagingStudy",
"type": "reference",
"documentation": "Who the study is about"
},
{
"name": "accession",
"definition": "http://hl7.org/fhir/profiles/ImagingStudy",
"type": "token",
"documentation": "The accession id for the image"
},
{
"name": "study",
"definition": "http://hl7.org/fhir/profiles/ImagingStudy",
"type": "token",
"documentation": "The study id for the image"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/ImagingStudy",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "modality",
"definition": "http://hl7.org/fhir/profiles/ImagingStudy",
"type": "token",
"documentation": "The modality of the image"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/ImagingStudy",
"type": "date",
"documentation": "The date the study was done was taken"
},
{
"name": "dicom-class",
"definition": "http://hl7.org/fhir/profiles/ImagingStudy",
"type": "token",
"documentation": "DICOM class type (0008,0016)"
},
{
"name": "size",
"definition": "http://hl7.org/fhir/profiles/ImagingStudy",
"type": "number",
"documentation": "The size of the image in MB - may include > or < in the value"
}
]
},
{
"type": "Immunization",
"profile": {
"reference": "http://hl7.org/fhir/Immunization"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "reaction",
"definition": "http://hl7.org/fhir/profiles/Immunization",
"type": "reference",
"documentation": "Additional information on reaction"
},
{
"name": "requester",
"definition": "http://hl7.org/fhir/profiles/Immunization",
"type": "reference",
"documentation": "The practitioner who ordered the vaccination"
},
{
"name": "dose-sequence",
"definition": "http://hl7.org/fhir/profiles/Immunization",
"type": "number",
"documentation": "What dose number within series?"
},
{
"name": "vaccine-type",
"definition": "http://hl7.org/fhir/profiles/Immunization",
"type": "token",
"documentation": "Vaccine Product Type Administered"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/profiles/Immunization",
"type": "reference",
"documentation": "The service delivery location or facility in which the vaccine was / was to be administered"
},
{
"name": "reason",
"definition": "http://hl7.org/fhir/profiles/Immunization",
"type": "token",
"documentation": "Why immunization occurred"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/Immunization",
"type": "reference",
"documentation": "The subject of the vaccination event / refusal"
},
{
"name": "reaction-date",
"definition": "http://hl7.org/fhir/profiles/Immunization",
"type": "date",
"documentation": "When did reaction start?"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/Immunization",
"type": "date",
"documentation": "Vaccination Administration / Refusal Date"
},
{
"name": "lot-number",
"definition": "http://hl7.org/fhir/profiles/Immunization",
"type": "string",
"documentation": "Vaccine Lot Number"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Immunization",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "manufacturer",
"definition": "http://hl7.org/fhir/profiles/Immunization",
"type": "reference",
"documentation": "Vaccine Manufacturer"
},
{
"name": "performer",
"definition": "http://hl7.org/fhir/profiles/Immunization",
"type": "reference",
"documentation": "The practitioner who administered the vaccination"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Immunization",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "refused",
"definition": "http://hl7.org/fhir/profiles/Immunization",
"type": "token",
"documentation": "Was immunization refused?"
},
{
"name": "refusal-reason",
"definition": "http://hl7.org/fhir/profiles/Immunization",
"type": "token",
"documentation": "Explanation of refusal / exemption"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/Immunization",
"type": "token",
"documentation": "Business identifier"
}
]
},
{
"type": "ImmunizationRecommendation",
"profile": {
"reference": "http://hl7.org/fhir/ImmunizationRecommendation"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "information",
"definition": "http://hl7.org/fhir/profiles/ImmunizationRecommendation",
"type": "reference",
"documentation": "Patient observations supporting recommendation"
},
{
"name": "dose-sequence",
"definition": "http://hl7.org/fhir/profiles/ImmunizationRecommendation",
"type": "token",
"documentation": "Number of dose within sequence"
},
{
"name": "support",
"definition": "http://hl7.org/fhir/profiles/ImmunizationRecommendation",
"type": "reference",
"documentation": "Past immunizations supporting recommendation"
},
{
"name": "vaccine-type",
"definition": "http://hl7.org/fhir/profiles/ImmunizationRecommendation",
"type": "token",
"documentation": "Vaccine recommendation applies to"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/ImmunizationRecommendation",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/ImmunizationRecommendation",
"type": "token",
"documentation": "Vaccine administration status"
},
{
"name": "dose-number",
"definition": "http://hl7.org/fhir/profiles/ImmunizationRecommendation",
"type": "number",
"documentation": "Recommended dose number"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/ImmunizationRecommendation",
"type": "reference",
"documentation": "Who this profile is for"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/ImmunizationRecommendation",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/ImmunizationRecommendation",
"type": "date",
"documentation": "Date recommendation created"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/ImmunizationRecommendation",
"type": "token",
"documentation": "Business identifier"
}
]
},
{
"type": "List",
"profile": {
"reference": "http://hl7.org/fhir/List"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "source",
"definition": "http://hl7.org/fhir/profiles/List",
"type": "reference",
"documentation": "Who and/or what defined the list contents"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/List",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/List",
"type": "reference",
"documentation": "If all resources have the same subject"
},
{
"name": "item",
"definition": "http://hl7.org/fhir/profiles/List",
"type": "reference",
"documentation": "Actual entry"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/List",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/profiles/List",
"type": "token",
"documentation": "What the purpose of this list is"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/List",
"type": "date",
"documentation": "When the list was prepared"
},
{
"name": "empty-reason",
"definition": "http://hl7.org/fhir/profiles/List",
"type": "token",
"documentation": "Why list is empty"
}
]
},
{
"type": "Location",
"profile": {
"reference": "http://hl7.org/fhir/Location"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "near",
"definition": "http://hl7.org/fhir/profiles/Location",
"type": "token",
"documentation": "The coordinates expressed as [lat],[long] (using KML, see notes) to find locations near to (servers may search using a square rather than a circle for efficiency)"
},
{
"name": "partof",
"definition": "http://hl7.org/fhir/profiles/Location",
"type": "reference",
"documentation": "The location of which this location is a part"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Location",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/Location",
"type": "token",
"documentation": "Searches for locations with a specific kind of status"
},
{
"name": "address",
"definition": "http://hl7.org/fhir/profiles/Location",
"type": "string",
"documentation": "A (part of the) address of the location"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/profiles/Location",
"type": "string",
"documentation": "A (portion of the) name of the location"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Location",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "near-distance",
"definition": "http://hl7.org/fhir/profiles/Location",
"type": "token",
"documentation": "A distance quantity to limit the near search to locations within a specific distance"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/profiles/Location",
"type": "token",
"documentation": "A code for the type of location"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/Location",
"type": "token",
"documentation": "Unique code or number identifying the location to its users"
}
]
},
{
"type": "Media",
"profile": {
"reference": "http://hl7.org/fhir/Media"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Media",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/Media",
"type": "reference",
"documentation": "Who/What this Media is a record of"
},
{
"name": "subtype",
"definition": "http://hl7.org/fhir/profiles/Media",
"type": "token",
"documentation": "The type of acquisition equipment/process"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Media",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "view",
"definition": "http://hl7.org/fhir/profiles/Media",
"type": "token",
"documentation": "Imaging view e.g Lateral or Antero-posterior"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/Media",
"type": "date",
"documentation": "When the media was taken/recorded (end)"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/profiles/Media",
"type": "token",
"documentation": "photo | video | audio"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/Media",
"type": "token",
"documentation": "Identifier(s) for the image"
},
{
"name": "operator",
"definition": "http://hl7.org/fhir/profiles/Media",
"type": "reference",
"documentation": "The person who generated the image"
}
]
},
{
"type": "Medication",
"profile": {
"reference": "http://hl7.org/fhir/Medication"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "content",
"definition": "http://hl7.org/fhir/profiles/Medication",
"type": "reference",
"documentation": "A product in the package"
},
{
"name": "form",
"definition": "http://hl7.org/fhir/profiles/Medication",
"type": "token",
"documentation": "powder | tablets | carton +"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Medication",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "container",
"definition": "http://hl7.org/fhir/profiles/Medication",
"type": "token",
"documentation": "E.g. box, vial, blister-pack"
},
{
"name": "manufacturer",
"definition": "http://hl7.org/fhir/profiles/Medication",
"type": "reference",
"documentation": "Manufacturer of the item"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/profiles/Medication",
"type": "string",
"documentation": "Common / Commercial name"
},
{
"name": "ingredient",
"definition": "http://hl7.org/fhir/profiles/Medication",
"type": "reference",
"documentation": "The product contained"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Medication",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/profiles/Medication",
"type": "token",
"documentation": "Codes that identify this medication"
}
]
},
{
"type": "MedicationAdministration",
"profile": {
"reference": "http://hl7.org/fhir/MedicationAdministration"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "medication",
"definition": "http://hl7.org/fhir/profiles/MedicationAdministration",
"type": "reference",
"documentation": "Return administrations of this medication"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/profiles/MedicationAdministration",
"type": "reference",
"documentation": "The identity of a patient to list administrations for"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/MedicationAdministration",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/MedicationAdministration",
"type": "token",
"documentation": "MedicationAdministration event status (for example one of active/paused/completed/nullified)"
},
{
"name": "prescription",
"definition": "http://hl7.org/fhir/profiles/MedicationAdministration",
"type": "reference",
"documentation": "The identity of a prescription to list administrations from"
},
{
"name": "device",
"definition": "http://hl7.org/fhir/profiles/MedicationAdministration",
"type": "reference",
"documentation": "Return administrations with this administration device identity"
},
{
"name": "notgiven",
"definition": "http://hl7.org/fhir/profiles/MedicationAdministration",
"type": "token",
"documentation": "Administrations that were not made"
},
{
"name": "whengiven",
"definition": "http://hl7.org/fhir/profiles/MedicationAdministration",
"type": "date",
"documentation": "Date of administration"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/MedicationAdministration",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/profiles/MedicationAdministration",
"type": "reference",
"documentation": "Return administrations that share this encounter"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/MedicationAdministration",
"type": "token",
"documentation": "Return administrations with this external identity"
}
]
},
{
"type": "MedicationDispense",
"profile": {
"reference": "http://hl7.org/fhir/MedicationDispense"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "medication",
"definition": "http://hl7.org/fhir/profiles/MedicationDispense",
"type": "reference",
"documentation": "Returns dispenses of this medicine"
},
{
"name": "prescription",
"definition": "http://hl7.org/fhir/profiles/MedicationDispense",
"type": "reference",
"documentation": "The identity of a prescription to list dispenses from"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/MedicationDispense",
"type": "token",
"documentation": "Status of the dispense"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/profiles/MedicationDispense",
"type": "token",
"documentation": "Return all dispenses of a specific type"
},
{
"name": "destination",
"definition": "http://hl7.org/fhir/profiles/MedicationDispense",
"type": "reference",
"documentation": "Return dispenses that should be sent to a secific destination"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/profiles/MedicationDispense",
"type": "reference",
"documentation": "The identity of a patient to list dispenses for"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/MedicationDispense",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "responsibleparty",
"definition": "http://hl7.org/fhir/profiles/MedicationDispense",
"type": "reference",
"documentation": "Return all dispenses with the specified responsible party"
},
{
"name": "dispenser",
"definition": "http://hl7.org/fhir/profiles/MedicationDispense",
"type": "reference",
"documentation": "Return all dispenses performed by a specific indiividual"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/MedicationDispense",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/MedicationDispense",
"type": "token",
"documentation": "Return dispenses with this external identity"
},
{
"name": "whenhandedover",
"definition": "http://hl7.org/fhir/profiles/MedicationDispense",
"type": "date",
"documentation": "Date when medication handed over to patient (outpatient setting), or supplied to ward or clinic (inpatient setting)"
},
{
"name": "whenprepared",
"definition": "http://hl7.org/fhir/profiles/MedicationDispense",
"type": "date",
"documentation": "Date when medication prepared"
}
]
},
{
"type": "MedicationPrescription",
"profile": {
"reference": "http://hl7.org/fhir/MedicationPrescription"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "medication",
"definition": "http://hl7.org/fhir/profiles/MedicationPrescription",
"type": "reference",
"documentation": "Code for medicine or text in medicine name"
},
{
"name": "datewritten",
"definition": "http://hl7.org/fhir/profiles/MedicationPrescription",
"type": "date",
"documentation": "Return prescriptions written on this date"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/profiles/MedicationPrescription",
"type": "reference",
"documentation": "The identity of a patient to list dispenses for"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/MedicationPrescription",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/MedicationPrescription",
"type": "token",
"documentation": "Status of the prescription"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/MedicationPrescription",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/profiles/MedicationPrescription",
"type": "reference",
"documentation": "Return prescriptions with this encounter identity"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/MedicationPrescription",
"type": "token",
"documentation": "Return prescriptions with this external identity"
}
]
},
{
"type": "MedicationStatement",
"profile": {
"reference": "http://hl7.org/fhir/MedicationStatement"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "medication",
"definition": "http://hl7.org/fhir/profiles/MedicationStatement",
"type": "reference",
"documentation": "Code for medicine or text in medicine name"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/profiles/MedicationStatement",
"type": "reference",
"documentation": "The identity of a patient to list administrations for"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/MedicationStatement",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "device",
"definition": "http://hl7.org/fhir/profiles/MedicationStatement",
"type": "reference",
"documentation": "Return administrations with this administration device identity"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/MedicationStatement",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "when-given",
"definition": "http://hl7.org/fhir/profiles/MedicationStatement",
"type": "date",
"documentation": "Date of administration"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/MedicationStatement",
"type": "token",
"documentation": "Return administrations with this external identity"
}
]
},
{
"type": "MessageHeader",
"profile": {
"reference": "http://hl7.org/fhir/MessageHeader"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/MessageHeader",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/MessageHeader",
"type": "token",
"documentation": "The language of the resource"
}
]
},
{
"type": "Observation",
"profile": {
"reference": "http://hl7.org/fhir/Observation"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "value-string",
"definition": "http://hl7.org/fhir/profiles/Observation",
"type": "string",
"documentation": "The value of the observation, if the value is a string, and also searches in CodeableConcept.text"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/Observation",
"type": "token",
"documentation": "The status of the observation"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/Observation",
"type": "reference",
"documentation": "The subject that the observation is about"
},
{
"name": "value-concept",
"definition": "http://hl7.org/fhir/profiles/Observation",
"type": "token",
"documentation": "The value of the observation, if the value is a CodeableConcept"
},
{
"name": "reliability",
"definition": "http://hl7.org/fhir/profiles/Observation",
"type": "token",
"documentation": "The reliability of the observation"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/Observation",
"type": "date",
"documentation": "Obtained date/time. If the obtained element is a period, a date that falls in the period"
},
{
"name": "name-value-[x]",
"definition": "http://hl7.org/fhir/profiles/Observation",
"type": "composite",
"documentation": "Both name and one of the value parameters"
},
{
"name": "related-target",
"definition": "http://hl7.org/fhir/profiles/Observation",
"type": "reference",
"documentation": "Observation that is related to this one"
},
{
"name": "related",
"definition": "http://hl7.org/fhir/profiles/Observation",
"type": "composite",
"documentation": "Related Observations - search on related-type and related-target together"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Observation",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "specimen",
"definition": "http://hl7.org/fhir/profiles/Observation",
"type": "reference",
"documentation": "Specimen used for this observation"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/profiles/Observation",
"type": "token",
"documentation": "The name of the observation type"
},
{
"name": "related-type",
"definition": "http://hl7.org/fhir/profiles/Observation",
"type": "token",
"documentation": "has-component | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by"
},
{
"name": "performer",
"definition": "http://hl7.org/fhir/profiles/Observation",
"type": "reference",
"documentation": "Who and/or what performed the observation"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Observation",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "value-quantity",
"definition": "http://hl7.org/fhir/profiles/Observation",
"type": "quantity",
"documentation": "The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)"
},
{
"name": "value-date",
"definition": "http://hl7.org/fhir/profiles/Observation",
"type": "date",
"documentation": "The value of the observation, if the value is a Period"
}
]
},
{
"type": "OperationOutcome",
"profile": {
"reference": "http://hl7.org/fhir/OperationOutcome"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/OperationOutcome",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/OperationOutcome",
"type": "token",
"documentation": "The language of the resource"
}
]
},
{
"type": "Order",
"profile": {
"reference": "http://hl7.org/fhir/Order"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "authority",
"definition": "http://hl7.org/fhir/profiles/Order",
"type": "reference",
"documentation": "If required by policy"
},
{
"name": "detail",
"definition": "http://hl7.org/fhir/profiles/Order",
"type": "reference",
"documentation": "What action is being ordered"
},
{
"name": "source",
"definition": "http://hl7.org/fhir/profiles/Order",
"type": "reference",
"documentation": "Who initiated the order"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Order",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/Order",
"type": "reference",
"documentation": "Patient this order is about"
},
{
"name": "when",
"definition": "http://hl7.org/fhir/profiles/Order",
"type": "date",
"documentation": "A formal schedule"
},
{
"name": "target",
"definition": "http://hl7.org/fhir/profiles/Order",
"type": "reference",
"documentation": "Who is intended to fulfill the order"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Order",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "when_code",
"definition": "http://hl7.org/fhir/profiles/Order",
"type": "token",
"documentation": "Code specifies when request should be done. The code may simply be a priority code"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/Order",
"type": "date",
"documentation": "When the order was made"
}
]
},
{
"type": "OrderResponse",
"profile": {
"reference": "http://hl7.org/fhir/OrderResponse"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/OrderResponse",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "fulfillment",
"definition": "http://hl7.org/fhir/profiles/OrderResponse",
"type": "reference",
"documentation": "Details of the outcome of performing the order"
},
{
"name": "request",
"definition": "http://hl7.org/fhir/profiles/OrderResponse",
"type": "reference",
"documentation": "The order that this is a response to"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/OrderResponse",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/profiles/OrderResponse",
"type": "token",
"documentation": "pending | review | rejected | error | accepted | cancelled | replaced | aborted | complete"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/OrderResponse",
"type": "date",
"documentation": "When the response was made"
},
{
"name": "who",
"definition": "http://hl7.org/fhir/profiles/OrderResponse",
"type": "reference",
"documentation": "Who made the response"
}
]
},
{
"type": "Organization",
"profile": {
"reference": "http://hl7.org/fhir/Organization"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "phonetic",
"definition": "http://hl7.org/fhir/profiles/Organization",
"type": "string",
"documentation": "A portion of the organization's name using some kind of phonetic matching algorithm"
},
{
"name": "partof",
"definition": "http://hl7.org/fhir/profiles/Organization",
"type": "reference",
"documentation": "Search all organizations that are part of the given organization"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Organization",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/profiles/Organization",
"type": "string",
"documentation": "A portion of the organization's name"
},
{
"name": "active",
"definition": "http://hl7.org/fhir/profiles/Organization",
"type": "token",
"documentation": "Whether the organization's record is active"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Organization",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/profiles/Organization",
"type": "token",
"documentation": "A code for the type of organization"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/Organization",
"type": "token",
"documentation": "Any identifier for the organization (not the accreditation issuer's identifier)"
}
]
},
{
"type": "Other",
"profile": {
"reference": "http://hl7.org/fhir/Other"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Other",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "created",
"definition": "http://hl7.org/fhir/profiles/Other",
"type": "date",
"documentation": "When created"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/Other",
"type": "reference",
"documentation": "Identifies the"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Other",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/profiles/Other",
"type": "token",
"documentation": "Kind of Resource"
}
]
},
{
"type": "Patient",
"profile": {
"reference": "http://hl7.org/fhir/Patient"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "animal-breed",
"definition": "http://hl7.org/fhir/profiles/Patient",
"type": "token",
"documentation": "The breed for animal patients"
},
{
"name": "phonetic",
"definition": "http://hl7.org/fhir/profiles/Patient",
"type": "string",
"documentation": "A portion of either family or given name using some kind of phonetic matching algorithm"
},
{
"name": "link",
"definition": "http://hl7.org/fhir/profiles/Patient",
"type": "reference",
"documentation": "All patients linked to the given patient"
},
{
"name": "provider",
"definition": "http://hl7.org/fhir/profiles/Patient",
"type": "reference",
"documentation": "The organization at which this person is a patient"
},
{
"name": "animal-species",
"definition": "http://hl7.org/fhir/profiles/Patient",
"type": "token",
"documentation": "The species for animal patients"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Patient",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "given",
"definition": "http://hl7.org/fhir/profiles/Patient",
"type": "string",
"documentation": "A portion of the given name of the patient"
},
{
"name": "address",
"definition": "http://hl7.org/fhir/profiles/Patient",
"type": "string",
"documentation": "An address in any kind of address/part of the patient"
},
{
"name": "family",
"definition": "http://hl7.org/fhir/profiles/Patient",
"type": "string",
"documentation": "A portion of the family name of the patient"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/profiles/Patient",
"type": "string",
"documentation": "A portion of either family or given name of the patient"
},
{
"name": "telecom",
"definition": "http://hl7.org/fhir/profiles/Patient",
"type": "string",
"documentation": "The value in any kind of telecom details of the patient"
},
{
"name": "birthdate",
"definition": "http://hl7.org/fhir/profiles/Patient",
"type": "date",
"documentation": "The patient's date of birth"
},
{
"name": "active",
"definition": "http://hl7.org/fhir/profiles/Patient",
"type": "token",
"documentation": "Whether the patient record is active"
},
{
"name": "gender",
"definition": "http://hl7.org/fhir/profiles/Patient",
"type": "token",
"documentation": "Gender of the patient"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Patient",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "language",
"definition": "http://hl7.org/fhir/profiles/Patient",
"type": "token",
"documentation": "Language code (irrespective of use value)"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/Patient",
"type": "token",
"documentation": "A patient identifier"
}
]
},
{
"type": "Practitioner",
"profile": {
"reference": "http://hl7.org/fhir/Practitioner"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "organization",
"definition": "http://hl7.org/fhir/profiles/Practitioner",
"type": "reference",
"documentation": "The identity of the organization the practitioner represents / acts on behalf of"
},
{
"name": "phonetic",
"definition": "http://hl7.org/fhir/profiles/Practitioner",
"type": "string",
"documentation": "A portion of either family or given name using some kind of phonetic matching algorithm"
},
{
"name": "given",
"definition": "http://hl7.org/fhir/profiles/Practitioner",
"type": "string",
"documentation": "A portion of the given name"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Practitioner",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "address",
"definition": "http://hl7.org/fhir/profiles/Practitioner",
"type": "string",
"documentation": "An address in any kind of address/part"
},
{
"name": "family",
"definition": "http://hl7.org/fhir/profiles/Practitioner",
"type": "string",
"documentation": "A portion of the family name"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/profiles/Practitioner",
"type": "string",
"documentation": "A portion of either family or given name"
},
{
"name": "telecom",
"definition": "http://hl7.org/fhir/profiles/Practitioner",
"type": "string",
"documentation": "The value in any kind of contact"
},
{
"name": "gender",
"definition": "http://hl7.org/fhir/profiles/Practitioner",
"type": "token",
"documentation": "Gender of the practitioner"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Practitioner",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/Practitioner",
"type": "token",
"documentation": "A practitioner's Identifier"
}
]
},
{
"type": "Procedure",
"profile": {
"reference": "http://hl7.org/fhir/Procedure"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Procedure",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/Procedure",
"type": "reference",
"documentation": "The identity of a patient to list procedures for"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Procedure",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/Procedure",
"type": "date",
"documentation": "The date the procedure was performed on"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/profiles/Procedure",
"type": "token",
"documentation": "Type of procedure"
}
]
},
{
"type": "Profile",
"profile": {
"reference": "http://hl7.org/fhir/Profile"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/Profile",
"type": "token",
"documentation": "The current status of the profile"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/profiles/Profile",
"type": "token",
"documentation": "A code for the profile in the format uri::code (server may choose to do subsumption)"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/Profile",
"type": "date",
"documentation": "The profile publication date"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/profiles/Profile",
"type": "token",
"documentation": "Type of resource that is constrained in the profile"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/profiles/Profile",
"type": "token",
"documentation": "The version identifier of the profile"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/profiles/Profile",
"type": "string",
"documentation": "Name of the publisher of the profile"
},
{
"name": "extension",
"definition": "http://hl7.org/fhir/profiles/Profile",
"type": "token",
"documentation": "An extension code (use or definition)"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Profile",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "valueset",
"definition": "http://hl7.org/fhir/profiles/Profile",
"type": "reference",
"documentation": "A vocabulary binding code"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/profiles/Profile",
"type": "string",
"documentation": "Text search in the description of the profile"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/profiles/Profile",
"type": "string",
"documentation": "Name of the profile"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Profile",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/Profile",
"type": "token",
"documentation": "The identifier of the profile"
}
]
},
{
"type": "Provenance",
"profile": {
"reference": "http://hl7.org/fhir/Provenance"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Provenance",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/profiles/Provenance",
"type": "reference",
"documentation": "Where the activity occurred, if relevant"
},
{
"name": "start",
"definition": "http://hl7.org/fhir/profiles/Provenance",
"type": "date",
"documentation": "Starting time with inclusive boundary"
},
{
"name": "partytype",
"definition": "http://hl7.org/fhir/profiles/Provenance",
"type": "token",
"documentation": "e.g. Resource | Person | Application | Record | Document +"
},
{
"name": "target",
"definition": "http://hl7.org/fhir/profiles/Provenance",
"type": "reference",
"documentation": "Target resource(s) (usually version specific)"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Provenance",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "party",
"definition": "http://hl7.org/fhir/profiles/Provenance",
"type": "token",
"documentation": "Identity of agent (urn or url)"
},
{
"name": "end",
"definition": "http://hl7.org/fhir/profiles/Provenance",
"type": "date",
"documentation": "End time with inclusive boundary, if not ongoing"
}
]
},
{
"type": "Query",
"profile": {
"reference": "http://hl7.org/fhir/Query"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "response",
"definition": "http://hl7.org/fhir/profiles/Query",
"type": "token",
"documentation": "Links response to source query"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Query",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Query",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/Query",
"type": "token",
"documentation": "Links query and its response(s)"
}
]
},
{
"type": "Questionnaire",
"profile": {
"reference": "http://hl7.org/fhir/Questionnaire"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "author",
"definition": "http://hl7.org/fhir/profiles/Questionnaire",
"type": "reference",
"documentation": "The author of the questionnaire"
},
{
"name": "authored",
"definition": "http://hl7.org/fhir/profiles/Questionnaire",
"type": "date",
"documentation": "When the questionnaire was authored"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Questionnaire",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/Questionnaire",
"type": "token",
"documentation": "The status of the questionnaire"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/Questionnaire",
"type": "reference",
"documentation": "The subject of the questionnaire"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/profiles/Questionnaire",
"type": "token",
"documentation": "Name of the questionnaire"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Questionnaire",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/profiles/Questionnaire",
"type": "reference",
"documentation": "Encounter during which questionnaire was authored"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/Questionnaire",
"type": "token",
"documentation": "An identifier for the questionnaire"
}
]
},
{
"type": "RelatedPerson",
"profile": {
"reference": "http://hl7.org/fhir/RelatedPerson"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/profiles/RelatedPerson",
"type": "reference",
"documentation": "The patient this person is related to"
},
{
"name": "phonetic",
"definition": "http://hl7.org/fhir/profiles/RelatedPerson",
"type": "string",
"documentation": "A portion of name using some kind of phonetic matching algorithm"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/RelatedPerson",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "address",
"definition": "http://hl7.org/fhir/profiles/RelatedPerson",
"type": "string",
"documentation": "An address in any kind of address/part"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/profiles/RelatedPerson",
"type": "string",
"documentation": "A portion of name in any name part"
},
{
"name": "telecom",
"definition": "http://hl7.org/fhir/profiles/RelatedPerson",
"type": "string",
"documentation": "The value in any kind of contact"
},
{
"name": "gender",
"definition": "http://hl7.org/fhir/profiles/RelatedPerson",
"type": "token",
"documentation": "Gender of the person"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/RelatedPerson",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/RelatedPerson",
"type": "token",
"documentation": "A patient Identifier"
}
]
},
{
"type": "SecurityEvent",
"profile": {
"reference": "http://hl7.org/fhir/SecurityEvent"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "site",
"definition": "http://hl7.org/fhir/profiles/SecurityEvent",
"type": "token",
"documentation": "Logical source location within the enterprise"
},
{
"name": "desc",
"definition": "http://hl7.org/fhir/profiles/SecurityEvent",
"type": "string",
"documentation": "Instance-specific descriptor for Object"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/profiles/SecurityEvent",
"type": "token",
"documentation": "Type/identifier of event"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/SecurityEvent",
"type": "date",
"documentation": "Time when the event occurred on source"
},
{
"name": "reference",
"definition": "http://hl7.org/fhir/profiles/SecurityEvent",
"type": "reference",
"documentation": "Specific instance of resource (e.g. versioned)"
},
{
"name": "identity",
"definition": "http://hl7.org/fhir/profiles/SecurityEvent",
"type": "token",
"documentation": "Specific instance of object (e.g. versioned)"
},
{
"name": "altid",
"definition": "http://hl7.org/fhir/profiles/SecurityEvent",
"type": "token",
"documentation": "Alternative User id e.g. authentication"
},
{
"name": "patientid",
"definition": "http://hl7.org/fhir/profiles/SecurityEvent",
"type": "token",
"documentation": "The id of the patient (one of multiple kinds of participations)"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/SecurityEvent",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "source",
"definition": "http://hl7.org/fhir/profiles/SecurityEvent",
"type": "token",
"documentation": "The id of source where event originated"
},
{
"name": "address",
"definition": "http://hl7.org/fhir/profiles/SecurityEvent",
"type": "token",
"documentation": "Identifier for the network access point of the user device"
},
{
"name": "subtype",
"definition": "http://hl7.org/fhir/profiles/SecurityEvent",
"type": "token",
"documentation": "More specific type/id for the event"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/profiles/SecurityEvent",
"type": "string",
"documentation": "Human-meaningful name for the user"
},
{
"name": "action",
"definition": "http://hl7.org/fhir/profiles/SecurityEvent",
"type": "token",
"documentation": "Type of action performed during the event"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/SecurityEvent",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "object-type",
"definition": "http://hl7.org/fhir/profiles/SecurityEvent",
"type": "token",
"documentation": "Object type being audited"
},
{
"name": "user",
"definition": "http://hl7.org/fhir/profiles/SecurityEvent",
"type": "token",
"documentation": "Unique identifier for the user"
}
]
},
{
"type": "Specimen",
"profile": {
"reference": "http://hl7.org/fhir/Specimen"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Specimen",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/Specimen",
"type": "reference",
"documentation": "The subject of the specimen"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Specimen",
"type": "token",
"documentation": "The language of the resource"
}
]
},
{
"type": "Substance",
"profile": {
"reference": "http://hl7.org/fhir/Substance"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "substance",
"definition": "http://hl7.org/fhir/profiles/Substance",
"type": "reference",
"documentation": "A component of the substance"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Substance",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "quantity",
"definition": "http://hl7.org/fhir/profiles/Substance",
"type": "number",
"documentation": "Amount of substance in the package"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Substance",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/profiles/Substance",
"type": "token",
"documentation": "The type of the substance"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/Substance",
"type": "token",
"documentation": "Identifier of the package/container"
},
{
"name": "expiry",
"definition": "http://hl7.org/fhir/profiles/Substance",
"type": "date",
"documentation": "When no longer valid to use"
}
]
},
{
"type": "Supply",
"profile": {
"reference": "http://hl7.org/fhir/Supply"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/profiles/Supply",
"type": "reference",
"documentation": "Patient for whom the item is supplied"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Supply",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/Supply",
"type": "token",
"documentation": "requested | dispensed | received | failed | cancelled"
},
{
"name": "dispenseid",
"definition": "http://hl7.org/fhir/profiles/Supply",
"type": "token",
"documentation": "External identifier"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Supply",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/Supply",
"type": "token",
"documentation": "Unique identifier"
},
{
"name": "supplier",
"definition": "http://hl7.org/fhir/profiles/Supply",
"type": "reference",
"documentation": "Dispenser"
},
{
"name": "kind",
"definition": "http://hl7.org/fhir/profiles/Supply",
"type": "token",
"documentation": "The kind of supply (central, non-stock, etc)"
},
{
"name": "dispensestatus",
"definition": "http://hl7.org/fhir/profiles/Supply",
"type": "token",
"documentation": "in progress | dispensed | abandoned"
}
]
},
{
"type": "ValueSet",
"profile": {
"reference": "http://hl7.org/fhir/ValueSet"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "system",
"definition": "http://hl7.org/fhir/profiles/ValueSet",
"type": "token",
"documentation": "The system for any codes defined by this value set"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/ValueSet",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/ValueSet",
"type": "token",
"documentation": "The status of the value set"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/profiles/ValueSet",
"type": "string",
"documentation": "Text search in the description of the value set"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/profiles/ValueSet",
"type": "string",
"documentation": "The name of the value set"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/ValueSet",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/profiles/ValueSet",
"type": "token",
"documentation": "A code defined in the value set"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/ValueSet",
"type": "date",
"documentation": "The value set publication date"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/ValueSet",
"type": "token",
"documentation": "The identifier of the value set"
},
{
"name": "reference",
"definition": "http://hl7.org/fhir/profiles/ValueSet",
"type": "token",
"documentation": "A code system included or excluded in the value set or an imported value set"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/profiles/ValueSet",
"type": "string",
"documentation": "Name of the publisher of the value set"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/profiles/ValueSet",
"type": "token",
"documentation": "The version identifier of the value set"
}
]
}
],
"operation": [
{
"code": "transaction"
},
{
"code": "history-system"
},
{
"code": "search-system"
}
]
}
]
},
"summary": "<div><h2>Base FHIR Conformance Statement (Full)</h2><p>This is the base conformance statement for FHIR. It represents a server that provides the full set of functionality defined by FHIR. It is provided to use as a template for system designers to build their own conformance statements from</p><table><tr><td>Mode</td><td>server</td></tr><tr><td>Description</td><td>All the functionality defined in FHIR</td></tr><tr><td>Transaction</td><td>y</td></tr><tr><td>System History</td><td>y</td></tr><tr><td>System Search</td><td>y</td></tr></table><table><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th><b>Read</b></th><th><b>V-Read</b></th><th><b>Search</b></th><th><b>Update</b></th><th><b>Updates</b></th><th><b>Create</b></th><th><b>Delete</b></th><th><b>History</b></th></tr><tr><td>AdverseReaction</td><td><a href=\"http://hl7.org/fhir/AdverseReaction\">http://hl7.org/fhir/AdverseReaction</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Alert</td><td><a href=\"http://hl7.org/fhir/Alert\">http://hl7.org/fhir/Alert</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>AllergyIntolerance</td><td><a href=\"http://hl7.org/fhir/AllergyIntolerance\">http://hl7.org/fhir/AllergyIntolerance</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>CarePlan</td><td><a href=\"http://hl7.org/fhir/CarePlan\">http://hl7.org/fhir/CarePlan</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Composition</td><td><a href=\"http://hl7.org/fhir/Composition\">http://hl7.org/fhir/Composition</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>ConceptMap</td><td><a href=\"http://hl7.org/fhir/ConceptMap\">http://hl7.org/fhir/ConceptMap</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Condition</td><td><a href=\"http://hl7.org/fhir/Condition\">http://hl7.org/fhir/Condition</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Conformance</td><td><a href=\"http://hl7.org/fhir/Conformance\">http://hl7.org/fhir/Conformance</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Device</td><td><a href=\"http://hl7.org/fhir/Device\">http://hl7.org/fhir/Device</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>DeviceObservationReport</td><td><a href=\"http://hl7.org/fhir/DeviceObservationReport\">http://hl7.org/fhir/DeviceObservationReport</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>DiagnosticOrder</td><td><a href=\"http://hl7.org/fhir/DiagnosticOrder\">http://hl7.org/fhir/DiagnosticOrder</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>DiagnosticReport</td><td><a href=\"http://hl7.org/fhir/DiagnosticReport\">http://hl7.org/fhir/DiagnosticReport</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>DocumentManifest</td><td><a href=\"http://hl7.org/fhir/DocumentManifest\">http://hl7.org/fhir/DocumentManifest</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>DocumentReference</td><td><a href=\"http://hl7.org/fhir/DocumentReference\">http://hl7.org/fhir/DocumentReference</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Encounter</td><td><a href=\"http://hl7.org/fhir/Encounter\">http://hl7.org/fhir/Encounter</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>FamilyHistory</td><td><a href=\"http://hl7.org/fhir/FamilyHistory\">http://hl7.org/fhir/FamilyHistory</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Group</td><td><a href=\"http://hl7.org/fhir/Group\">http://hl7.org/fhir/Group</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>ImagingStudy</td><td><a href=\"http://hl7.org/fhir/ImagingStudy\">http://hl7.org/fhir/ImagingStudy</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Immunization</td><td><a href=\"http://hl7.org/fhir/Immunization\">http://hl7.org/fhir/Immunization</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>ImmunizationRecommendation</td><td><a href=\"http://hl7.org/fhir/ImmunizationRecommendation\">http://hl7.org/fhir/ImmunizationRecommendation</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>List</td><td><a href=\"http://hl7.org/fhir/List\">http://hl7.org/fhir/List</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Location</td><td><a href=\"http://hl7.org/fhir/Location\">http://hl7.org/fhir/Location</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Media</td><td><a href=\"http://hl7.org/fhir/Media\">http://hl7.org/fhir/Media</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Medication</td><td><a href=\"http://hl7.org/fhir/Medication\">http://hl7.org/fhir/Medication</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>MedicationAdministration</td><td><a href=\"http://hl7.org/fhir/MedicationAdministration\">http://hl7.org/fhir/MedicationAdministration</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>MedicationDispense</td><td><a href=\"http://hl7.org/fhir/MedicationDispense\">http://hl7.org/fhir/MedicationDispense</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>MedicationPrescription</td><td><a href=\"http://hl7.org/fhir/MedicationPrescription\">http://hl7.org/fhir/MedicationPrescription</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>MedicationStatement</td><td><a href=\"http://hl7.org/fhir/MedicationStatement\">http://hl7.org/fhir/MedicationStatement</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>MessageHeader</td><td><a href=\"http://hl7.org/fhir/MessageHeader\">http://hl7.org/fhir/MessageHeader</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Observation</td><td><a href=\"http://hl7.org/fhir/Observation\">http://hl7.org/fhir/Observation</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>OperationOutcome</td><td><a href=\"http://hl7.org/fhir/OperationOutcome\">http://hl7.org/fhir/OperationOutcome</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Order</td><td><a href=\"http://hl7.org/fhir/Order\">http://hl7.org/fhir/Order</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>OrderResponse</td><td><a href=\"http://hl7.org/fhir/OrderResponse\">http://hl7.org/fhir/OrderResponse</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Organization</td><td><a href=\"http://hl7.org/fhir/Organization\">http://hl7.org/fhir/Organization</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Other</td><td><a href=\"http://hl7.org/fhir/Other\">http://hl7.org/fhir/Other</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Patient</td><td><a href=\"http://hl7.org/fhir/Patient\">http://hl7.org/fhir/Patient</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Practitioner</td><td><a href=\"http://hl7.org/fhir/Practitioner\">http://hl7.org/fhir/Practitioner</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Procedure</td><td><a href=\"http://hl7.org/fhir/Procedure\">http://hl7.org/fhir/Procedure</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Profile</td><td><a href=\"http://hl7.org/fhir/Profile\">http://hl7.org/fhir/Profile</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Provenance</td><td><a href=\"http://hl7.org/fhir/Provenance\">http://hl7.org/fhir/Provenance</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Query</td><td><a href=\"http://hl7.org/fhir/Query\">http://hl7.org/fhir/Query</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Questionnaire</td><td><a href=\"http://hl7.org/fhir/Questionnaire\">http://hl7.org/fhir/Questionnaire</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>RelatedPerson</td><td><a href=\"http://hl7.org/fhir/RelatedPerson\">http://hl7.org/fhir/RelatedPerson</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>SecurityEvent</td><td><a href=\"http://hl7.org/fhir/SecurityEvent\">http://hl7.org/fhir/SecurityEvent</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Specimen</td><td><a href=\"http://hl7.org/fhir/Specimen\">http://hl7.org/fhir/Specimen</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Substance</td><td><a href=\"http://hl7.org/fhir/Substance\">http://hl7.org/fhir/Substance</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Supply</td><td><a href=\"http://hl7.org/fhir/Supply\">http://hl7.org/fhir/Supply</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>ValueSet</td><td><a href=\"http://hl7.org/fhir/ValueSet\">http://hl7.org/fhir/ValueSet</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr></table></div>"
},
{
"title": "\"conformance-base2\" - to help with system development",
"id": "http://hl7.org/fhir/conformance/conformance-base2",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/conformance/conformance-base2"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Conformance",
"text": {
"status": "generated",
"div": "<div><h2>Base FHIR Conformance Statement (Empty)</h2><p>This is the base conformance statement for FHIR. It represents a server that provides the none of the functionality defined by FHIR. It is provided to use as a template for system designers to build their own conformance statements from. A conformance profile has to contain something, so this contains a read of a Conformance Statement</p><table><tr><td>Mode</td><td>server</td></tr><tr><td>Description</td><td>An empty conformance statement</td></tr><tr><td>Transaction</td><td></td></tr><tr><td>System History</td><td></td></tr><tr><td>System Search</td><td></td></tr></table><table><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th><b>Read</b></th><th><b>V-Read</b></th><th><b>Search</b></th><th><b>Update</b></th><th><b>Updates</b></th><th><b>Create</b></th><th><b>Delete</b></th><th><b>History</b></th></tr><tr><td>Conformance</td><td>y</td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr></table></div>"
},
"identifier": "http://hl7.org/fhir/conformance-base2",
"version": "0.0.82.2943",
"name": "Base FHIR Conformance Statement (Empty)",
"publisher": "FHIR Project Team",
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
],
"description": "This is the base conformance statement for FHIR. It represents a server that provides the none of the functionality defined by FHIR. It is provided to use as a template for system designers to build their own conformance statements from. A conformance profile has to contain something, so this contains a read of a Conformance Statement",
"status": "draft",
"date": "2014-09-30T18:08:29.499+10:00",
"fhirVersion": "0.0.82",
"acceptUnknown": false,
"format": [
"xml",
"json"
],
"rest": [
{
"mode": "server",
"documentation": "An empty conformance statement",
"resource": [
{
"type": "Conformance",
"operation": [
{
"code": "read"
}
]
}
]
}
]
},
"summary": "<div><h2>Base FHIR Conformance Statement (Empty)</h2><p>This is the base conformance statement for FHIR. It represents a server that provides the none of the functionality defined by FHIR. It is provided to use as a template for system designers to build their own conformance statements from. A conformance profile has to contain something, so this contains a read of a Conformance Statement</p><table><tr><td>Mode</td><td>server</td></tr><tr><td>Description</td><td>An empty conformance statement</td></tr><tr><td>Transaction</td><td></td></tr><tr><td>System History</td><td></td></tr><tr><td>System Search</td><td></td></tr></table><table><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th><b>Read</b></th><th><b>V-Read</b></th><th><b>Search</b></th><th><b>Update</b></th><th><b>Updates</b></th><th><b>Create</b></th><th><b>Delete</b></th><th><b>History</b></th></tr><tr><td>Conformance</td><td>y</td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr></table></div>"
},
{
"title": "\"valueset\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/valueset",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/valueset.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"A value set specifies a set of codes drawn from one or more code systems.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet\"><b>ValueSet</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"The identifier that is used to identify this value set when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI).\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.identifier\"><b>identifier</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Logical id to reference this value set<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The identifier that is used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.version\"><b>version</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Logical id for this version of the value set<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A free text natural language name describing the value set.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Informal name for this value set<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The name of the individual or organization that published the value set.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.publisher\"><b>publisher</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Name of the publisher (Organization or individual)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Contacts of the publisher to assist a user in finding and communicating with the publisher.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.telecom\"><b>telecom</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">Contact information of the publisher<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></telecom>\r\n <<a title=\"A free text natural language description of the use of the value set - reason for definition, conditions of use, etc.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Human language description of the value set<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A copyright statement relating to the value set and/or its contents.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.copyright\"><b>copyright</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">About the value set or its content</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The status of the value set (this element modifies the meaning of other elements)\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-status.html\">draft | active | retired<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"This valueset was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.experimental\"><b>experimental</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">If for testing purposes, not real usage<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Whether this is intended to be used with an extensible binding or not.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.extensible\"><b>extensible</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Whether this is intended to be used with an extensible binding</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The date that the value set status was last changed.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.date\"><b>date</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Date for given status<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"When value set defines its own codes.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.define\"><b>define</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-5: Value set SHALL contain either a define, a compose, or an expansion element\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> When value set defines its own codes<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span> --></span>\r\n <<a title=\"URI to identify the code system.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.define.system\"><b>system</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">URI to identify the code system<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The version of this code system that defines the codes. Note that the version is optional because a well maintained code system does not suffer from versioning, and therefore the version does not need to be maintained. However many code systems are not well maintained, and the version needs to be defined and tracked.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.define.version\"><b>version</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Version of this system<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"If code comparison is case sensitive when codes within this system are compared to each other.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.define.caseSensitive\"><b>caseSensitive</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">If code comparison is case sensitive<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Concepts in the code system.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.define.concept\"><b>concept</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Concepts in the code system --></span>\r\n <<a title=\"Code that identifies concept.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.define.concept.code\"><b>code</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Code that identifies concept</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"If this code is not for use as a real concept.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.define.concept.abstract\"><b>abstract</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">If this code is not for use as a real concept</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Text to Display to the user.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.define.concept.display\"><b>display</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Text to Display to the user</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The formal definition of the concept. Formal definitions are not required, because of the prevalence of legacy systems without them, but they are highly recommended, as without them there is no formal meaning associated with the concept.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.define.concept.definition\"><b>definition</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Formal Definition</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Child Concepts (is-a / contains).\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.define.concept.concept\"><b>concept</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\">Content as for ValueSet.define.concept</span> <span style=\"color: navy\">Child Concepts (is-a / contains)</span><span style=\"color: Gray\"> --></span></concept>\r\n </concept>\r\n </define>\r\n <<a title=\"When value set includes codes from elsewhere.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.compose\"><b>compose</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-5: Value set SHALL contain either a define, a compose, or an expansion element\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> When value set includes codes from elsewhere --></span>\r\n <<a title=\"Includes the contents of the referenced value set as a part of the contents of this value set.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.compose.import\"><b>import</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: A value set composition SHALL have an include or an import\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> <span style=\"color: navy\">Import the contents of another value set<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Include one or more codes from a code system.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.compose.include\"><b>include</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-1: A value set composition SHALL have an include or an import\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> Include one or more codes from a code system<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span> --></span>\r\n <<a title=\"The code system from which the selected codes come from.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.compose.include.system\"><b>system</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">The system the codes come from<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The version of the code system that the codes are selected from.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.compose.include.version\"><b>version</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Specific version of the code system referred to<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Specifies a code or concept to be included or excluded. The list of codes is considered ordered, though the order may not have any particular significance.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.compose.include.code\"><b>code</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: navy\">Code or concept from system</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Select concepts by specify a matching criteria based on the properties (including relationships) defined by the system. If multiple filters are specified, they SHALL all be true.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.compose.include.filter\"><b>filter</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Select codes/concepts by their properties (including relationships) --></span>\r\n <<a title=\"A code that identifies a property defined in the code system.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.compose.include.filter.property\"><b>property</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">A property defined by the code system</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The kind of operation to perform as a part of the filter criteria.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.compose.include.filter.op\"><b>op</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"filter-operator.html\">= | is-a | is-not-a | regex | in | not in</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The match value may be either a code defined by the system, or a string value which is used a regex match on the literal string of the property value.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.compose.include.filter.value\"><b>value</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Code from the system, or regex criteria</span><span style=\"color: Gray\"> --></span>\r\n </filter>\r\n </include>\r\n <<a title=\"Exclude one or more codes from the value set.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.compose.exclude\"><b>exclude</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: A value set with only one import SHALL also have an include and/or an exclude unless the value set defines its own codes\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> <span style=\"color: darkgreen\">Content as for ValueSet.compose.include</span> <span style=\"color: navy\">Explicitly exclude codes</span><span style=\"color: Gray\"> --></span></exclude>\r\n </compose>\r\n <<a title=\"When value set is an expansion.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.expansion\"><b>expansion</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-5: Value set SHALL contain either a define, a compose, or an expansion element\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> When value set is an expansion --></span>\r\n <<a title=\"An identifier that uniquely identifies this expansion of the valueset. Systems may re-use the same identifier as long as the expansion and the definition remain the same, but are not required to do so.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.expansion.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Uniquely identifies this expansion</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Time valueset expansion happened.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.expansion.timestamp\"><b>timestamp</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#instant\">instant</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Time valueset expansion happened</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Codes in the value set.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.expansion.contains\"><b>contains</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Codes in the value set --></span>\r\n <<a title=\"System value for the code.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.expansion.contains.system\"><b>system</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">System value for the code</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Code - if blank, this is not a choosable code.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.expansion.contains.code\"><b>code</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-6: SHALL have a code or a display\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Code - if blank, this is not a choosable code</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"User display for the concept.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.expansion.contains.display\"><b>display</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-6: SHALL have a code or a display\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">User display for the concept</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Codes contained in this concept.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.expansion.contains.contains\"><b>contains</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\">Content as for ValueSet.expansion.contains</span> <span style=\"color: navy\">Codes contained in this concept</span><span style=\"color: Gray\"> --></span></contains>\r\n </contains>\r\n </expansion>\r\n</ValueSet>\r\n</pre></div>"
},
"name": "valueset",
"publisher": "FHIR Project",
"description": "Basic Profile. A value set specifies a set of codes drawn from one or more code systems.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage Value sets may be constructed in one of two ways: \r\n\r\n* A value set can define its own codes, and/or\r\n* A value set can be composed of codes defined in other code systems, either by listing the codes or by providing a set of selection criteria\r\nA value set can also be \"expanded\", where the value set is turned into a simple collection of enumerated codes. This operation is performed to produce a collection of codes that are ready to use for data entry or validation. An expanded value set may also contain the original definition as well.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"structure": [
{
"type": "ValueSet",
"publish": true,
"element": [
{
"path": "ValueSet",
"definition": {
"short": "A set of codes drawn from one or more code systems",
"formal": "A value set specifies a set of codes drawn from one or more code systems.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"constraint": [
{
"key": "2",
"severity": "error",
"human": "A value set with only one import SHALL also have an include and/or an exclude unless the value set defines its own codes",
"xpath": "not(exists(f:compose)) or (count(f:compose/f:import)!=1 or exists(f:compose/f:include) or exists(f:compose/f:exclude) or exists(f:define))"
},
{
"key": "7",
"severity": "error",
"human": "A defined code system (if present) SHALL have a different identifier to the value set itself",
"xpath": "not(exists(f:define)) or (f:define/f:system/@value != f:identifier/@value)"
},
{
"key": "5",
"severity": "error",
"human": "Value set SHALL contain either a define, a compose, or an expansion element",
"xpath": "exists(f:define) or exists(f:compose) or exists(f:expansion)"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ValueSet.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.identifier",
"definition": {
"short": "Logical id to reference this value set",
"formal": "The identifier that is used to identify this value set when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI).",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ValueSet.version",
"definition": {
"short": "Logical id for this version of the value set",
"formal": "The identifier that is used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.",
"comments": "There may be multiple resource versions of the value set that have the same identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ValueSet.name",
"definition": {
"short": "Informal name for this value set",
"formal": "A free text natural language name describing the value set.",
"comments": "Not expected to be unique.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ValueSet.publisher",
"definition": {
"short": "Name of the publisher (Organization or individual)",
"formal": "The name of the individual or organization that published the value set.",
"comments": "Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.telecom",
"definition": {
"short": "Contact information of the publisher",
"formal": "Contacts of the publisher to assist a user in finding and communicating with the publisher.",
"comments": "May be a web site, an email address, a telephone number (tel:), etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "Contact"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.description",
"definition": {
"short": "Human language description of the value set",
"formal": "A free text natural language description of the use of the value set - reason for definition, conditions of use, etc.",
"comments": "The description is not intended to describe the semantics of the Value Set - there are no intrinsic semantics separate from the codes contained in its expansion. The description should capture its intended use, which is needed for ensuring integrity for its use in models across future changes.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ValueSet.copyright",
"definition": {
"short": "About the value set or its content",
"formal": "A copyright statement relating to the value set and/or its contents.",
"comments": "Frequently, the copyright differs between the value set, and codes that are included. The copyright statement should clearly differentiate between these when required.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.status",
"definition": {
"short": "draft | active | retired",
"formal": "The status of the value set.",
"comments": "Allows filtering of valuesets that are appropriate for use vs. not.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "ValueSetStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/valueset-status"
}
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ValueSet.experimental",
"definition": {
"short": "If for testing purposes, not real usage",
"formal": "This valueset was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"comments": "Allows filtering of valuesets that are appropriate for use vs. not.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.extensible",
"definition": {
"short": "Whether this is intended to be used with an extensible binding",
"formal": "Whether this is intended to be used with an extensible binding or not.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.date",
"definition": {
"short": "Date for given status",
"formal": "The date that the value set status was last changed.",
"comments": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the value set.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ValueSet.define",
"definition": {
"short": "When value set defines its own codes",
"formal": "When value set defines its own codes.",
"min": 0,
"max": "1",
"constraint": [
{
"key": "3",
"severity": "error",
"human": "Within a code system definition, all the codes SHALL be unique",
"xpath": "count(distinct-values(descendant::f:concept/f:code/@value))=count(descendant::f:concept)"
},
{
"key": "8",
"severity": "error",
"human": "Codes must be unique",
"xpath": "count(descendant::f:concept)=count(distinct-values(descendant::f:concept/f:code/@value))"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.define.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.define.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.define.system",
"definition": {
"short": "URI to identify the code system",
"formal": "URI to identify the code system.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.define.version",
"definition": {
"short": "Version of this system",
"formal": "The version of this code system that defines the codes. Note that the version is optional because a well maintained code system does not suffer from versioning, and therefore the version does not need to be maintained. However many code systems are not well maintained, and the version needs to be defined and tracked.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.define.caseSensitive",
"definition": {
"short": "If code comparison is case sensitive",
"formal": "If code comparison is case sensitive when codes within this system are compared to each other.",
"comments": "If this value is missing, then it is not specified whether a code system is case sensitive or not. When the rule is not known, Postel's law should be followed: produce codes with the correct case, and accept codes in any case. This element is primarily provided to support validation software.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.define.concept",
"definition": {
"short": "Concepts in the code system",
"formal": "Concepts in the code system.",
"min": 0,
"max": "*",
"isModifier": false
}
},
{
"path": "ValueSet.define.concept.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.define.concept.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.define.concept.code",
"definition": {
"short": "Code that identifies concept",
"formal": "Code that identifies concept.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.define.concept.abstract",
"definition": {
"short": "If this code is not for use as a real concept",
"formal": "If this code is not for use as a real concept.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.define.concept.display",
"definition": {
"short": "Text to Display to the user",
"formal": "Text to Display to the user.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.define.concept.definition",
"definition": {
"short": "Formal Definition",
"formal": "The formal definition of the concept. Formal definitions are not required, because of the prevalence of legacy systems without them, but they are highly recommended, as without them there is no formal meaning associated with the concept.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.define.concept.concept",
"definition": {
"short": "Child Concepts (is-a / contains)",
"formal": "Child Concepts (is-a / contains).",
"min": 0,
"max": "*",
"nameReference": "ValueSet.define.concept",
"isModifier": false
}
},
{
"path": "ValueSet.compose",
"definition": {
"short": "When value set includes codes from elsewhere",
"formal": "When value set includes codes from elsewhere.",
"min": 0,
"max": "1",
"constraint": [
{
"key": "1",
"severity": "error",
"human": "A value set composition SHALL have an include or an import",
"xpath": "exists(f:include) or exists(f:import)"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.compose.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.compose.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.compose.import",
"definition": {
"short": "Import the contents of another value set",
"formal": "Includes the contents of the referenced value set as a part of the contents of this value set.",
"comments": "The value set URI is either a logical reference to a defined value set such as a SNOMED CT reference set, or a literal reference to a value set definition (not an expansion). If the reference is a logical one, it may not reference a actual FHIR value set resource; in this case, the referenced definition of a set of coded values needs to be clear about how versions are resolved.",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ValueSet.compose.include",
"definition": {
"short": "Include one or more codes from a code system",
"formal": "Include one or more codes from a code system.",
"comments": "If there are no codes or filters, the entire code system is included.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ValueSet.compose.include.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.compose.include.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.compose.include.system",
"definition": {
"short": "The system the codes come from",
"formal": "The code system from which the selected codes come from.",
"comments": "See [[Coding.system]] for further documentation.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ValueSet.compose.include.version",
"definition": {
"short": "Specific version of the code system referred to",
"formal": "The version of the code system that the codes are selected from.",
"comments": "This is used when selecting the descendents of a concept - they may change between versions. If no version is specified, then the exact contents of the value set may not be known until a context of use binds it to a particular version.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ValueSet.compose.include.code",
"definition": {
"short": "Code or concept from system",
"formal": "Specifies a code or concept to be included or excluded. The list of codes is considered ordered, though the order may not have any particular significance.",
"comments": "Expressions are allowed if defined by the underlying code system.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ValueSet.compose.include.filter",
"definition": {
"short": "Select codes/concepts by their properties (including relationships)",
"formal": "Select concepts by specify a matching criteria based on the properties (including relationships) defined by the system. If multiple filters are specified, they SHALL all be true.",
"comments": "Selecting codes by specifying filters based on properties is only possible where the underlying code system defines appropriate properties. Note that in some cases, the underlying code system defines the logical concepts but not the literal codes for the concepts. In such cases, the literal definitions may be provided by a third party.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ValueSet.compose.include.filter.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.compose.include.filter.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.compose.include.filter.property",
"definition": {
"short": "A property defined by the code system",
"formal": "A code that identifies a property defined in the code system.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ValueSet.compose.include.filter.op",
"definition": {
"short": "= | is-a | is-not-a | regex | in | not in",
"formal": "The kind of operation to perform as a part of the filter criteria.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "FilterOperator",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/filter-operator"
}
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ValueSet.compose.include.filter.value",
"definition": {
"short": "Code from the system, or regex criteria",
"formal": "The match value may be either a code defined by the system, or a string value which is used a regex match on the literal string of the property value.",
"comments": "Use regex matching with care - full regex matching on every SNOMED CT term is prohibitive, for example.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ValueSet.compose.exclude",
"definition": {
"short": "Explicitly exclude codes",
"formal": "Exclude one or more codes from the value set.",
"comments": "Usually this is used to selectively exclude codes that were included by subsumption in the inclusions.",
"min": 0,
"max": "*",
"nameReference": "ValueSet.compose.include",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ValueSet.expansion",
"definition": {
"short": "When value set is an expansion",
"formal": "When value set is an expansion.",
"min": 0,
"max": "1",
"isModifier": false
}
},
{
"path": "ValueSet.expansion.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.expansion.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.expansion.identifier",
"definition": {
"short": "Uniquely identifies this expansion",
"formal": "An identifier that uniquely identifies this expansion of the valueset. Systems may re-use the same identifier as long as the expansion and the definition remain the same, but are not required to do so.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.expansion.timestamp",
"definition": {
"short": "Time valueset expansion happened",
"formal": "Time valueset expansion happened.",
"min": 1,
"max": "1",
"type": [
{
"code": "instant"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.expansion.contains",
"definition": {
"short": "Codes in the value set",
"formal": "Codes in the value set.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "6",
"severity": "error",
"human": "SHALL have a code or a display",
"xpath": "exists(f:code) or exists(f:display)"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.expansion.contains.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.expansion.contains.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.expansion.contains.system",
"definition": {
"short": "System value for the code",
"formal": "System value for the code.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.expansion.contains.code",
"definition": {
"short": "Code - if blank, this is not a choosable code",
"formal": "Code - if blank, this is not a choosable code.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.expansion.contains.display",
"definition": {
"short": "User display for the concept",
"formal": "User display for the concept.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.expansion.contains.contains",
"definition": {
"short": "Codes contained in this concept",
"formal": "Codes contained in this concept.",
"min": 0,
"max": "*",
"nameReference": "ValueSet.expansion.contains",
"isModifier": false
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "code",
"type": "token",
"documentation": "A code defined in the value set",
"xpath": "f:ValueSet/f:define/f:concept/f:code"
},
{
"name": "date",
"type": "date",
"documentation": "The value set publication date",
"xpath": "f:ValueSet/f:date"
},
{
"name": "description",
"type": "string",
"documentation": "Text search in the description of the value set",
"xpath": "f:ValueSet/f:description"
},
{
"name": "identifier",
"type": "token",
"documentation": "The identifier of the value set",
"xpath": "f:ValueSet/f:identifier"
},
{
"name": "name",
"type": "string",
"documentation": "The name of the value set",
"xpath": "f:ValueSet/f:name"
},
{
"name": "publisher",
"type": "string",
"documentation": "Name of the publisher of the value set",
"xpath": "f:ValueSet/f:publisher"
},
{
"name": "reference",
"type": "token",
"documentation": "A code system included or excluded in the value set or an imported value set",
"xpath": "f:ValueSet/f:compose/f:include/f:system"
},
{
"name": "status",
"type": "token",
"documentation": "The status of the value set",
"xpath": "f:ValueSet/f:status"
},
{
"name": "system",
"type": "token",
"documentation": "The system for any codes defined by this value set",
"xpath": "f:ValueSet/f:define/f:system"
},
{
"name": "version",
"type": "token",
"documentation": "The version identifier of the value set",
"xpath": "f:ValueSet/f:version"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"A value set specifies a set of codes drawn from one or more code systems.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet\"><b>ValueSet</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"The identifier that is used to identify this value set when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI).\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.identifier\"><b>identifier</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Logical id to reference this value set<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The identifier that is used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.version\"><b>version</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Logical id for this version of the value set<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A free text natural language name describing the value set.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Informal name for this value set<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The name of the individual or organization that published the value set.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.publisher\"><b>publisher</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Name of the publisher (Organization or individual)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Contacts of the publisher to assist a user in finding and communicating with the publisher.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.telecom\"><b>telecom</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">Contact information of the publisher<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></telecom>\r\n <<a title=\"A free text natural language description of the use of the value set - reason for definition, conditions of use, etc.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Human language description of the value set<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A copyright statement relating to the value set and/or its contents.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.copyright\"><b>copyright</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">About the value set or its content</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The status of the value set (this element modifies the meaning of other elements)\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-status.html\">draft | active | retired<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"This valueset was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.experimental\"><b>experimental</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">If for testing purposes, not real usage<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Whether this is intended to be used with an extensible binding or not.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.extensible\"><b>extensible</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Whether this is intended to be used with an extensible binding</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The date that the value set status was last changed.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.date\"><b>date</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Date for given status<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"When value set defines its own codes.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.define\"><b>define</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-5: Value set SHALL contain either a define, a compose, or an expansion element\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> When value set defines its own codes<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span> --></span>\r\n <<a title=\"URI to identify the code system.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.define.system\"><b>system</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">URI to identify the code system<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The version of this code system that defines the codes. Note that the version is optional because a well maintained code system does not suffer from versioning, and therefore the version does not need to be maintained. However many code systems are not well maintained, and the version needs to be defined and tracked.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.define.version\"><b>version</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Version of this system<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"If code comparison is case sensitive when codes within this system are compared to each other.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.define.caseSensitive\"><b>caseSensitive</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">If code comparison is case sensitive<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Concepts in the code system.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.define.concept\"><b>concept</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Concepts in the code system --></span>\r\n <<a title=\"Code that identifies concept.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.define.concept.code\"><b>code</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Code that identifies concept</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"If this code is not for use as a real concept.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.define.concept.abstract\"><b>abstract</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">If this code is not for use as a real concept</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Text to Display to the user.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.define.concept.display\"><b>display</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Text to Display to the user</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The formal definition of the concept. Formal definitions are not required, because of the prevalence of legacy systems without them, but they are highly recommended, as without them there is no formal meaning associated with the concept.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.define.concept.definition\"><b>definition</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Formal Definition</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Child Concepts (is-a / contains).\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.define.concept.concept\"><b>concept</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\">Content as for ValueSet.define.concept</span> <span style=\"color: navy\">Child Concepts (is-a / contains)</span><span style=\"color: Gray\"> --></span></concept>\r\n </concept>\r\n </define>\r\n <<a title=\"When value set includes codes from elsewhere.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.compose\"><b>compose</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-5: Value set SHALL contain either a define, a compose, or an expansion element\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> When value set includes codes from elsewhere --></span>\r\n <<a title=\"Includes the contents of the referenced value set as a part of the contents of this value set.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.compose.import\"><b>import</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: A value set composition SHALL have an include or an import\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> <span style=\"color: navy\">Import the contents of another value set<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Include one or more codes from a code system.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.compose.include\"><b>include</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-1: A value set composition SHALL have an include or an import\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> Include one or more codes from a code system<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span> --></span>\r\n <<a title=\"The code system from which the selected codes come from.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.compose.include.system\"><b>system</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">The system the codes come from<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The version of the code system that the codes are selected from.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.compose.include.version\"><b>version</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Specific version of the code system referred to<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Specifies a code or concept to be included or excluded. The list of codes is considered ordered, though the order may not have any particular significance.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.compose.include.code\"><b>code</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: navy\">Code or concept from system</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Select concepts by specify a matching criteria based on the properties (including relationships) defined by the system. If multiple filters are specified, they SHALL all be true.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.compose.include.filter\"><b>filter</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Select codes/concepts by their properties (including relationships) --></span>\r\n <<a title=\"A code that identifies a property defined in the code system.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.compose.include.filter.property\"><b>property</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">A property defined by the code system</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The kind of operation to perform as a part of the filter criteria.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.compose.include.filter.op\"><b>op</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"filter-operator.html\">= | is-a | is-not-a | regex | in | not in</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The match value may be either a code defined by the system, or a string value which is used a regex match on the literal string of the property value.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.compose.include.filter.value\"><b>value</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Code from the system, or regex criteria</span><span style=\"color: Gray\"> --></span>\r\n </filter>\r\n </include>\r\n <<a title=\"Exclude one or more codes from the value set.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.compose.exclude\"><b>exclude</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: A value set with only one import SHALL also have an include and/or an exclude unless the value set defines its own codes\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> <span style=\"color: darkgreen\">Content as for ValueSet.compose.include</span> <span style=\"color: navy\">Explicitly exclude codes</span><span style=\"color: Gray\"> --></span></exclude>\r\n </compose>\r\n <<a title=\"When value set is an expansion.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.expansion\"><b>expansion</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-5: Value set SHALL contain either a define, a compose, or an expansion element\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> When value set is an expansion --></span>\r\n <<a title=\"An identifier that uniquely identifies this expansion of the valueset. Systems may re-use the same identifier as long as the expansion and the definition remain the same, but are not required to do so.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.expansion.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Uniquely identifies this expansion</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Time valueset expansion happened.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.expansion.timestamp\"><b>timestamp</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#instant\">instant</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Time valueset expansion happened</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Codes in the value set.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.expansion.contains\"><b>contains</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Codes in the value set --></span>\r\n <<a title=\"System value for the code.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.expansion.contains.system\"><b>system</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">System value for the code</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Code - if blank, this is not a choosable code.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.expansion.contains.code\"><b>code</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-6: SHALL have a code or a display\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Code - if blank, this is not a choosable code</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"User display for the concept.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.expansion.contains.display\"><b>display</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-6: SHALL have a code or a display\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">User display for the concept</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Codes contained in this concept.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.expansion.contains.contains\"><b>contains</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\">Content as for ValueSet.expansion.contains</span> <span style=\"color: navy\">Codes contained in this concept</span><span style=\"color: Gray\"> --></span></contains>\r\n </contains>\r\n </expansion>\r\n</ValueSet>\r\n</pre></div>"
},
{
"title": "\"conformance-base\" - to help with system development",
"id": "http://hl7.org/fhir/conformance/conformance-base",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/conformance/conformance-base"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Conformance",
"text": {
"status": "generated",
"div": "<div><h2>Base FHIR Conformance Statement (Full)</h2><p>This is the base conformance statement for FHIR. It represents a server that provides the full set of functionality defined by FHIR. It is provided to use as a template for system designers to build their own conformance statements from</p><table><tr><td>Mode</td><td>server</td></tr><tr><td>Description</td><td>All the functionality defined in FHIR</td></tr><tr><td>Transaction</td><td>y</td></tr><tr><td>System History</td><td>y</td></tr><tr><td>System Search</td><td>y</td></tr></table><table><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th><b>Read</b></th><th><b>V-Read</b></th><th><b>Search</b></th><th><b>Update</b></th><th><b>Updates</b></th><th><b>Create</b></th><th><b>Delete</b></th><th><b>History</b></th></tr><tr><td>AdverseReaction</td><td><a href=\"http://hl7.org/fhir/AdverseReaction\">http://hl7.org/fhir/AdverseReaction</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Alert</td><td><a href=\"http://hl7.org/fhir/Alert\">http://hl7.org/fhir/Alert</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>AllergyIntolerance</td><td><a href=\"http://hl7.org/fhir/AllergyIntolerance\">http://hl7.org/fhir/AllergyIntolerance</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>CarePlan</td><td><a href=\"http://hl7.org/fhir/CarePlan\">http://hl7.org/fhir/CarePlan</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Composition</td><td><a href=\"http://hl7.org/fhir/Composition\">http://hl7.org/fhir/Composition</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>ConceptMap</td><td><a href=\"http://hl7.org/fhir/ConceptMap\">http://hl7.org/fhir/ConceptMap</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Condition</td><td><a href=\"http://hl7.org/fhir/Condition\">http://hl7.org/fhir/Condition</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Conformance</td><td><a href=\"http://hl7.org/fhir/Conformance\">http://hl7.org/fhir/Conformance</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Device</td><td><a href=\"http://hl7.org/fhir/Device\">http://hl7.org/fhir/Device</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>DeviceObservationReport</td><td><a href=\"http://hl7.org/fhir/DeviceObservationReport\">http://hl7.org/fhir/DeviceObservationReport</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>DiagnosticOrder</td><td><a href=\"http://hl7.org/fhir/DiagnosticOrder\">http://hl7.org/fhir/DiagnosticOrder</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>DiagnosticReport</td><td><a href=\"http://hl7.org/fhir/DiagnosticReport\">http://hl7.org/fhir/DiagnosticReport</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>DocumentManifest</td><td><a href=\"http://hl7.org/fhir/DocumentManifest\">http://hl7.org/fhir/DocumentManifest</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>DocumentReference</td><td><a href=\"http://hl7.org/fhir/DocumentReference\">http://hl7.org/fhir/DocumentReference</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Encounter</td><td><a href=\"http://hl7.org/fhir/Encounter\">http://hl7.org/fhir/Encounter</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>FamilyHistory</td><td><a href=\"http://hl7.org/fhir/FamilyHistory\">http://hl7.org/fhir/FamilyHistory</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Group</td><td><a href=\"http://hl7.org/fhir/Group\">http://hl7.org/fhir/Group</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>ImagingStudy</td><td><a href=\"http://hl7.org/fhir/ImagingStudy\">http://hl7.org/fhir/ImagingStudy</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Immunization</td><td><a href=\"http://hl7.org/fhir/Immunization\">http://hl7.org/fhir/Immunization</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>ImmunizationRecommendation</td><td><a href=\"http://hl7.org/fhir/ImmunizationRecommendation\">http://hl7.org/fhir/ImmunizationRecommendation</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>List</td><td><a href=\"http://hl7.org/fhir/List\">http://hl7.org/fhir/List</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Location</td><td><a href=\"http://hl7.org/fhir/Location\">http://hl7.org/fhir/Location</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Media</td><td><a href=\"http://hl7.org/fhir/Media\">http://hl7.org/fhir/Media</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Medication</td><td><a href=\"http://hl7.org/fhir/Medication\">http://hl7.org/fhir/Medication</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>MedicationAdministration</td><td><a href=\"http://hl7.org/fhir/MedicationAdministration\">http://hl7.org/fhir/MedicationAdministration</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>MedicationDispense</td><td><a href=\"http://hl7.org/fhir/MedicationDispense\">http://hl7.org/fhir/MedicationDispense</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>MedicationPrescription</td><td><a href=\"http://hl7.org/fhir/MedicationPrescription\">http://hl7.org/fhir/MedicationPrescription</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>MedicationStatement</td><td><a href=\"http://hl7.org/fhir/MedicationStatement\">http://hl7.org/fhir/MedicationStatement</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>MessageHeader</td><td><a href=\"http://hl7.org/fhir/MessageHeader\">http://hl7.org/fhir/MessageHeader</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Observation</td><td><a href=\"http://hl7.org/fhir/Observation\">http://hl7.org/fhir/Observation</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>OperationOutcome</td><td><a href=\"http://hl7.org/fhir/OperationOutcome\">http://hl7.org/fhir/OperationOutcome</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Order</td><td><a href=\"http://hl7.org/fhir/Order\">http://hl7.org/fhir/Order</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>OrderResponse</td><td><a href=\"http://hl7.org/fhir/OrderResponse\">http://hl7.org/fhir/OrderResponse</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Organization</td><td><a href=\"http://hl7.org/fhir/Organization\">http://hl7.org/fhir/Organization</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Other</td><td><a href=\"http://hl7.org/fhir/Other\">http://hl7.org/fhir/Other</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Patient</td><td><a href=\"http://hl7.org/fhir/Patient\">http://hl7.org/fhir/Patient</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Practitioner</td><td><a href=\"http://hl7.org/fhir/Practitioner\">http://hl7.org/fhir/Practitioner</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Procedure</td><td><a href=\"http://hl7.org/fhir/Procedure\">http://hl7.org/fhir/Procedure</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Profile</td><td><a href=\"http://hl7.org/fhir/Profile\">http://hl7.org/fhir/Profile</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Provenance</td><td><a href=\"http://hl7.org/fhir/Provenance\">http://hl7.org/fhir/Provenance</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Query</td><td><a href=\"http://hl7.org/fhir/Query\">http://hl7.org/fhir/Query</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Questionnaire</td><td><a href=\"http://hl7.org/fhir/Questionnaire\">http://hl7.org/fhir/Questionnaire</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>RelatedPerson</td><td><a href=\"http://hl7.org/fhir/RelatedPerson\">http://hl7.org/fhir/RelatedPerson</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>SecurityEvent</td><td><a href=\"http://hl7.org/fhir/SecurityEvent\">http://hl7.org/fhir/SecurityEvent</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Specimen</td><td><a href=\"http://hl7.org/fhir/Specimen\">http://hl7.org/fhir/Specimen</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Substance</td><td><a href=\"http://hl7.org/fhir/Substance\">http://hl7.org/fhir/Substance</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Supply</td><td><a href=\"http://hl7.org/fhir/Supply\">http://hl7.org/fhir/Supply</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>ValueSet</td><td><a href=\"http://hl7.org/fhir/ValueSet\">http://hl7.org/fhir/ValueSet</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr></table></div>"
},
"identifier": "http://hl7.org/fhir/conformance-base",
"version": "0.0.82.2943",
"name": "Base FHIR Conformance Statement (Full)",
"publisher": "FHIR Project Team",
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
],
"description": "This is the base conformance statement for FHIR. It represents a server that provides the full set of functionality defined by FHIR. It is provided to use as a template for system designers to build their own conformance statements from",
"status": "draft",
"date": "2014-09-30T18:08:29.499+10:00",
"fhirVersion": "0.0.82",
"acceptUnknown": false,
"format": [
"xml",
"json"
],
"rest": [
{
"mode": "server",
"documentation": "All the functionality defined in FHIR",
"resource": [
{
"type": "AdverseReaction",
"profile": {
"reference": "http://hl7.org/fhir/AdverseReaction"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "substance",
"definition": "http://hl7.org/fhir/profiles/AdverseReaction",
"type": "reference",
"documentation": "The name or code of the substance that produces the sensitivity"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/AdverseReaction",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/AdverseReaction",
"type": "reference",
"documentation": "The subject that the sensitivity is about"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/AdverseReaction",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/AdverseReaction",
"type": "date",
"documentation": "The date of the reaction"
},
{
"name": "symptom",
"definition": "http://hl7.org/fhir/profiles/AdverseReaction",
"type": "token",
"documentation": "One of the symptoms of the reaction"
}
]
},
{
"type": "Alert",
"profile": {
"reference": "http://hl7.org/fhir/Alert"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Alert",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/Alert",
"type": "reference",
"documentation": "The identity of a subject to list alerts for"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Alert",
"type": "token",
"documentation": "The language of the resource"
}
]
},
{
"type": "AllergyIntolerance",
"profile": {
"reference": "http://hl7.org/fhir/AllergyIntolerance"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "substance",
"definition": "http://hl7.org/fhir/profiles/AllergyIntolerance",
"type": "reference",
"documentation": "The name or code of the substance that produces the sensitivity"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/AllergyIntolerance",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/AllergyIntolerance",
"type": "token",
"documentation": "The status of the sensitivity"
},
{
"name": "recorder",
"definition": "http://hl7.org/fhir/profiles/AllergyIntolerance",
"type": "reference",
"documentation": "Who recorded the sensitivity"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/AllergyIntolerance",
"type": "reference",
"documentation": "The subject that the sensitivity is about"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/AllergyIntolerance",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/AllergyIntolerance",
"type": "date",
"documentation": "Recorded date/time."
},
{
"name": "type",
"definition": "http://hl7.org/fhir/profiles/AllergyIntolerance",
"type": "token",
"documentation": "The type of sensitivity"
}
]
},
{
"type": "CarePlan",
"profile": {
"reference": "http://hl7.org/fhir/CarePlan"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "activitycode",
"definition": "http://hl7.org/fhir/profiles/CarePlan",
"type": "token",
"documentation": "Detail type of activity"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/profiles/CarePlan",
"type": "reference",
"documentation": "Who care plan is for"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/CarePlan",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "condition",
"definition": "http://hl7.org/fhir/profiles/CarePlan",
"type": "reference",
"documentation": "Health issues this plan addresses"
},
{
"name": "activitydetail",
"definition": "http://hl7.org/fhir/profiles/CarePlan",
"type": "reference",
"documentation": "Activity details defined in specific resource"
},
{
"name": "activitydate",
"definition": "http://hl7.org/fhir/profiles/CarePlan",
"type": "date",
"documentation": "Specified date occurs within period specified by CarePlan.activity.timingSchedule"
},
{
"name": "participant",
"definition": "http://hl7.org/fhir/profiles/CarePlan",
"type": "reference",
"documentation": "Who is involved"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/CarePlan",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/CarePlan",
"type": "date",
"documentation": "Time period plan covers"
}
]
},
{
"type": "Composition",
"profile": {
"reference": "http://hl7.org/fhir/Composition"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "author",
"definition": "http://hl7.org/fhir/profiles/Composition",
"type": "reference",
"documentation": "Who and/or what authored the composition"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Composition",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "attester",
"definition": "http://hl7.org/fhir/profiles/Composition",
"type": "reference",
"documentation": "Who attested the composition"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/Composition",
"type": "reference",
"documentation": "Who and/or what the composition is about"
},
{
"name": "section-content",
"definition": "http://hl7.org/fhir/profiles/Composition",
"type": "reference",
"documentation": "The actual data for the section"
},
{
"name": "context",
"definition": "http://hl7.org/fhir/profiles/Composition",
"type": "token",
"documentation": "Code(s) that apply to the event being documented"
},
{
"name": "class",
"definition": "http://hl7.org/fhir/profiles/Composition",
"type": "token",
"documentation": "Categorization of Composition"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Composition",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "section-type",
"definition": "http://hl7.org/fhir/profiles/Composition",
"type": "token",
"documentation": "Classification of section (recommended)"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/Composition",
"type": "date",
"documentation": "Composition editing time"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/profiles/Composition",
"type": "token",
"documentation": "Kind of composition (LOINC if possible)"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/Composition",
"type": "token",
"documentation": "Logical identifier of composition (version-independent)"
}
]
},
{
"type": "ConceptMap",
"profile": {
"reference": "http://hl7.org/fhir/ConceptMap"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "dependson",
"definition": "http://hl7.org/fhir/profiles/ConceptMap",
"type": "token",
"documentation": "Reference to element/field/valueset provides the context"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/ConceptMap",
"type": "token",
"documentation": "Status of the concept map"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/ConceptMap",
"type": "date",
"documentation": "The concept map publication date"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/profiles/ConceptMap",
"type": "token",
"documentation": "The version identifier of the concept map"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/profiles/ConceptMap",
"type": "string",
"documentation": "Name of the publisher of the concept map"
},
{
"name": "product",
"definition": "http://hl7.org/fhir/profiles/ConceptMap",
"type": "token",
"documentation": "Reference to element/field/valueset provides the context"
},
{
"name": "system",
"definition": "http://hl7.org/fhir/profiles/ConceptMap",
"type": "token",
"documentation": "The system for any destination concepts mapped by this map"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/ConceptMap",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "source",
"definition": "http://hl7.org/fhir/profiles/ConceptMap",
"type": "reference",
"documentation": "The system for any concepts mapped by this concept map"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/profiles/ConceptMap",
"type": "string",
"documentation": "Text search in the description of the concept map"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/profiles/ConceptMap",
"type": "string",
"documentation": "Name of the concept map"
},
{
"name": "target",
"definition": "http://hl7.org/fhir/profiles/ConceptMap",
"type": "reference",
"documentation": "Provides context to the mappings"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/ConceptMap",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/ConceptMap",
"type": "token",
"documentation": "The identifier of the concept map"
}
]
},
{
"type": "Condition",
"profile": {
"reference": "http://hl7.org/fhir/Condition"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "asserter",
"definition": "http://hl7.org/fhir/profiles/Condition",
"type": "reference",
"documentation": "Person who asserts this condition"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/Condition",
"type": "token",
"documentation": "The status of the condition"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/profiles/Condition",
"type": "token",
"documentation": "Location - may include laterality"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/Condition",
"type": "reference",
"documentation": "Who has the condition?"
},
{
"name": "onset",
"definition": "http://hl7.org/fhir/profiles/Condition",
"type": "date",
"documentation": "When the Condition started (if started on a date)"
},
{
"name": "evidence",
"definition": "http://hl7.org/fhir/profiles/Condition",
"type": "token",
"documentation": "Manifestation/symptom"
},
{
"name": "severity",
"definition": "http://hl7.org/fhir/profiles/Condition",
"type": "token",
"documentation": "The severity of the condition"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/profiles/Condition",
"type": "token",
"documentation": "Code for the condition"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/profiles/Condition",
"type": "reference",
"documentation": "Encounter when condition first asserted"
},
{
"name": "date-asserted",
"definition": "http://hl7.org/fhir/profiles/Condition",
"type": "date",
"documentation": "When first detected/suspected/entered"
},
{
"name": "stage",
"definition": "http://hl7.org/fhir/profiles/Condition",
"type": "token",
"documentation": "Simple summary (disease specific)"
},
{
"name": "related-code",
"definition": "http://hl7.org/fhir/profiles/Condition",
"type": "token",
"documentation": "Relationship target by means of a predefined code"
},
{
"name": "category",
"definition": "http://hl7.org/fhir/profiles/Condition",
"type": "token",
"documentation": "The category of the condition"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Condition",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "related-item",
"definition": "http://hl7.org/fhir/profiles/Condition",
"type": "reference",
"documentation": "Relationship target resource"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Condition",
"type": "token",
"documentation": "The language of the resource"
}
]
},
{
"type": "Conformance",
"profile": {
"reference": "http://hl7.org/fhir/Conformance"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "token",
"documentation": "The current status of the conformance statement"
},
{
"name": "resource",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "token",
"documentation": "Name of a resource mentioned in a conformance statement"
},
{
"name": "security",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "token",
"documentation": "Information about security of implementation"
},
{
"name": "format",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "token",
"documentation": "formats supported (xml | json | mime type)"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "date",
"documentation": "The conformance statement publication date"
},
{
"name": "mode",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "token",
"documentation": "Mode - restful (server/client) or messaging (sender/receiver)"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "token",
"documentation": "The version identifier of the conformance statement"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "string",
"documentation": "Name of the publisher of the conformance statement"
},
{
"name": "software",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "string",
"documentation": "Part of a the name of a software application"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "string",
"documentation": "Text search in the description of the conformance statement"
},
{
"name": "event",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "token",
"documentation": "Event code in a conformance statement"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "string",
"documentation": "Name of the conformance statement"
},
{
"name": "supported-profile",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "reference",
"documentation": "Profiles supported by the system"
},
{
"name": "fhirversion",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "token",
"documentation": "The version of FHIR"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "token",
"documentation": "The identifier of the conformance statement"
},
{
"name": "profile",
"definition": "http://hl7.org/fhir/profiles/Conformance",
"type": "reference",
"documentation": "A profile id invoked in a conformance statement"
}
]
},
{
"type": "Device",
"profile": {
"reference": "http://hl7.org/fhir/Device"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "organization",
"definition": "http://hl7.org/fhir/profiles/Device",
"type": "reference",
"documentation": "The organization responsible for the device"
},
{
"name": "model",
"definition": "http://hl7.org/fhir/profiles/Device",
"type": "string",
"documentation": "The model of the device"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/profiles/Device",
"type": "reference",
"documentation": "Patient information, if the resource is affixed to a person"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Device",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/profiles/Device",
"type": "reference",
"documentation": "A location, where the resource is found"
},
{
"name": "manufacturer",
"definition": "http://hl7.org/fhir/profiles/Device",
"type": "string",
"documentation": "The manufacturer of the device"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Device",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "udi",
"definition": "http://hl7.org/fhir/profiles/Device",
"type": "string",
"documentation": "FDA Mandated Unique Device Identifier"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/profiles/Device",
"type": "token",
"documentation": "The type of the device"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/Device",
"type": "token",
"documentation": "Instance id from manufacturer, owner and others"
}
]
},
{
"type": "DeviceObservationReport",
"profile": {
"reference": "http://hl7.org/fhir/DeviceObservationReport"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "observation",
"definition": "http://hl7.org/fhir/profiles/DeviceObservationReport",
"type": "reference",
"documentation": "The data for the metric"
},
{
"name": "source",
"definition": "http://hl7.org/fhir/profiles/DeviceObservationReport",
"type": "reference",
"documentation": "Identifies/describes where the data came from"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/DeviceObservationReport",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/DeviceObservationReport",
"type": "reference",
"documentation": "Subject of the measurement"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/DeviceObservationReport",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/profiles/DeviceObservationReport",
"type": "token",
"documentation": "The compatment code"
},
{
"name": "channel",
"definition": "http://hl7.org/fhir/profiles/DeviceObservationReport",
"type": "token",
"documentation": "The channel code"
}
]
},
{
"type": "DiagnosticOrder",
"profile": {
"reference": "http://hl7.org/fhir/DiagnosticOrder"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "orderer",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "reference",
"documentation": "Who ordered the test"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "token",
"documentation": "requested | received | accepted | in progress | review | completed | suspended | rejected | failed"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "reference",
"documentation": "Who and/or what test is about"
},
{
"name": "item-status",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "token",
"documentation": "requested | received | accepted | in progress | review | completed | suspended | rejected | failed"
},
{
"name": "event-status",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "token",
"documentation": "requested | received | accepted | in progress | review | completed | suspended | rejected | failed"
},
{
"name": "actor",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "reference",
"documentation": "Who recorded or did this"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "token",
"documentation": "Code to indicate the item (test or panel) being ordered"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "reference",
"documentation": "The encounter that this diagnostic order is associated with"
},
{
"name": "item-past-status",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "token",
"documentation": "requested | received | accepted | in progress | review | completed | suspended | rejected | failed"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "bodysite",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "token",
"documentation": "Location of requested test (if applicable)"
},
{
"name": "item-date",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "date",
"documentation": "The date at which the event happened"
},
{
"name": "specimen",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "reference",
"documentation": "If the whole order relates to specific specimens"
},
{
"name": "event-status-date",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "composite",
"documentation": "A combination of past-status and date"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "event-date",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "date",
"documentation": "The date at which the event happened"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "token",
"documentation": "Identifiers assigned to this order"
},
{
"name": "item-status-date",
"definition": "http://hl7.org/fhir/profiles/DiagnosticOrder",
"type": "composite",
"documentation": "A combination of item-past-status and item-date"
}
]
},
{
"type": "DiagnosticReport",
"profile": {
"reference": "http://hl7.org/fhir/DiagnosticReport"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "result",
"definition": "http://hl7.org/fhir/profiles/DiagnosticReport",
"type": "reference",
"documentation": "Link to an atomic result (observation resource)"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/DiagnosticReport",
"type": "token",
"documentation": "The status of the report"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/DiagnosticReport",
"type": "reference",
"documentation": "The subject of the report"
},
{
"name": "issued",
"definition": "http://hl7.org/fhir/profiles/DiagnosticReport",
"type": "date",
"documentation": "When the report was issued"
},
{
"name": "diagnosis",
"definition": "http://hl7.org/fhir/profiles/DiagnosticReport",
"type": "token",
"documentation": "A coded diagnosis on the report"
},
{
"name": "image",
"definition": "http://hl7.org/fhir/profiles/DiagnosticReport",
"type": "reference",
"documentation": "Reference to the image source"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/DiagnosticReport",
"type": "date",
"documentation": "The clinically relevant time of the report"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/DiagnosticReport",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "request",
"definition": "http://hl7.org/fhir/profiles/DiagnosticReport",
"type": "reference",
"documentation": "What was requested"
},
{
"name": "specimen",
"definition": "http://hl7.org/fhir/profiles/DiagnosticReport",
"type": "reference",
"documentation": "The specimen details"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/profiles/DiagnosticReport",
"type": "token",
"documentation": "The name of the report (e.g. the code for the report as a whole, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result)"
},
{
"name": "service",
"definition": "http://hl7.org/fhir/profiles/DiagnosticReport",
"type": "token",
"documentation": "Which diagnostic discipline/department created the report"
},
{
"name": "performer",
"definition": "http://hl7.org/fhir/profiles/DiagnosticReport",
"type": "reference",
"documentation": "Who was the source of the report (organization)"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/DiagnosticReport",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/DiagnosticReport",
"type": "token",
"documentation": "An identifier for the report"
}
]
},
{
"type": "DocumentManifest",
"profile": {
"reference": "http://hl7.org/fhir/DocumentManifest"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "supersedes",
"definition": "http://hl7.org/fhir/profiles/DocumentManifest",
"type": "reference",
"documentation": "If this document manifest replaces another"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/DocumentManifest",
"type": "token",
"documentation": "current | superceded | entered in error"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/DocumentManifest",
"type": "reference",
"documentation": "The subject of the set of documents"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/profiles/DocumentManifest",
"type": "token",
"documentation": "What kind of document set this is"
},
{
"name": "recipient",
"definition": "http://hl7.org/fhir/profiles/DocumentManifest",
"type": "reference",
"documentation": "Intended to get notified about this set of documents"
},
{
"name": "content",
"definition": "http://hl7.org/fhir/profiles/DocumentManifest",
"type": "reference",
"documentation": "Contents of this set of documents"
},
{
"name": "author",
"definition": "http://hl7.org/fhir/profiles/DocumentManifest",
"type": "reference",
"documentation": "Who and/or what authored the document"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/DocumentManifest",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "created",
"definition": "http://hl7.org/fhir/profiles/DocumentManifest",
"type": "date",
"documentation": "When this document manifest created"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/profiles/DocumentManifest",
"type": "string",
"documentation": "Human-readable description (title)"
},
{
"name": "confidentiality",
"definition": "http://hl7.org/fhir/profiles/DocumentManifest",
"type": "token",
"documentation": "Sensitivity of set of documents"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/DocumentManifest",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/DocumentManifest",
"type": "token",
"documentation": "Unique Identifier for the set of documents"
}
]
},
{
"type": "DocumentReference",
"profile": {
"reference": "http://hl7.org/fhir/DocumentReference"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "location",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "string",
"documentation": "Where to access the document"
},
{
"name": "indexed",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "date",
"documentation": "When this document reference created"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "token",
"documentation": "current | superceded | entered in error"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "reference",
"documentation": "Who|what is the subject of the document"
},
{
"name": "relatesto",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "reference",
"documentation": "Target of the relationship"
},
{
"name": "relation",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "token",
"documentation": "replaces | transforms | signs | appends"
},
{
"name": "class",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "token",
"documentation": "Categorization of Document"
},
{
"name": "format",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "token",
"documentation": "Format/content rules for the document"
},
{
"name": "period",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "date",
"documentation": "Time of service that is being documented"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "token",
"documentation": "What kind of document this is (LOINC if possible)"
},
{
"name": "authenticator",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "reference",
"documentation": "Who/What authenticated the document"
},
{
"name": "size",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "number",
"documentation": "Size of the document in bytes"
},
{
"name": "relationship",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "composite",
"documentation": "Combination of relation and relatesTo"
},
{
"name": "author",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "reference",
"documentation": "Who and/or what authored the document"
},
{
"name": "custodian",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "reference",
"documentation": "Org which maintains the document"
},
{
"name": "facility",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "token",
"documentation": "Kind of facility where patient was seen"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "created",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "date",
"documentation": "Document creation time"
},
{
"name": "event",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "token",
"documentation": "Main Clinical Acts Documented"
},
{
"name": "confidentiality",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "token",
"documentation": "Sensitivity of source document"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "string",
"documentation": "Human-readable description (title)"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "language",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "token",
"documentation": "The marked primary language for the document"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/DocumentReference",
"type": "token",
"documentation": "Master Version Specific Identifier"
}
]
},
{
"type": "Encounter",
"profile": {
"reference": "http://hl7.org/fhir/Encounter"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Encounter",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/profiles/Encounter",
"type": "reference",
"documentation": "Location the encounter takes place"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/Encounter",
"type": "token",
"documentation": "planned | in progress | onleave | finished | cancelled"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/Encounter",
"type": "reference",
"documentation": "The patient present at the encounter"
},
{
"name": "indication",
"definition": "http://hl7.org/fhir/profiles/Encounter",
"type": "reference",
"documentation": "Reason the encounter takes place (resource)"
},
{
"name": "length",
"definition": "http://hl7.org/fhir/profiles/Encounter",
"type": "number",
"documentation": "Length of encounter in days"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Encounter",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/Encounter",
"type": "date",
"documentation": "A date within the period the Encounter lasted"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/Encounter",
"type": "token",
"documentation": "Identifier(s) by which this encounter is known"
},
{
"name": "location-period",
"definition": "http://hl7.org/fhir/profiles/Encounter",
"type": "date",
"documentation": "Time period during which the patient was present at the location"
}
]
},
{
"type": "FamilyHistory",
"profile": {
"reference": "http://hl7.org/fhir/FamilyHistory"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/FamilyHistory",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/FamilyHistory",
"type": "reference",
"documentation": "The identity of a subject to list family history items for"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/FamilyHistory",
"type": "token",
"documentation": "The language of the resource"
}
]
},
{
"type": "Group",
"profile": {
"reference": "http://hl7.org/fhir/Group"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "member",
"definition": "http://hl7.org/fhir/profiles/Group",
"type": "reference",
"documentation": "Who is in group"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Group",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "characteristic-value",
"definition": "http://hl7.org/fhir/profiles/Group",
"type": "composite",
"documentation": "A composite of both characteristic and value"
},
{
"name": "value",
"definition": "http://hl7.org/fhir/profiles/Group",
"type": "token",
"documentation": "Value held by characteristic"
},
{
"name": "actual",
"definition": "http://hl7.org/fhir/profiles/Group",
"type": "token",
"documentation": "Descriptive or actual"
},
{
"name": "exclude",
"definition": "http://hl7.org/fhir/profiles/Group",
"type": "token",
"documentation": "Group includes or excludes"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Group",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/profiles/Group",
"type": "token",
"documentation": "The kind of resources contained"
},
{
"name": "characteristic",
"definition": "http://hl7.org/fhir/profiles/Group",
"type": "token",
"documentation": "Kind of characteristic"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/profiles/Group",
"type": "token",
"documentation": "The type of resources the group contains"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/Group",
"type": "token",
"documentation": "Unique id"
}
]
},
{
"type": "ImagingStudy",
"profile": {
"reference": "http://hl7.org/fhir/ImagingStudy"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "uid",
"definition": "http://hl7.org/fhir/profiles/ImagingStudy",
"type": "token",
"documentation": "Formal identifier for this instance (0008,0018)"
},
{
"name": "series",
"definition": "http://hl7.org/fhir/profiles/ImagingStudy",
"type": "token",
"documentation": "The series id for the image"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/ImagingStudy",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "bodysite",
"definition": "http://hl7.org/fhir/profiles/ImagingStudy",
"type": "token",
"documentation": "Body part examined (Map from 0018,0015)"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/ImagingStudy",
"type": "reference",
"documentation": "Who the study is about"
},
{
"name": "accession",
"definition": "http://hl7.org/fhir/profiles/ImagingStudy",
"type": "token",
"documentation": "The accession id for the image"
},
{
"name": "study",
"definition": "http://hl7.org/fhir/profiles/ImagingStudy",
"type": "token",
"documentation": "The study id for the image"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/ImagingStudy",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "modality",
"definition": "http://hl7.org/fhir/profiles/ImagingStudy",
"type": "token",
"documentation": "The modality of the image"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/ImagingStudy",
"type": "date",
"documentation": "The date the study was done was taken"
},
{
"name": "dicom-class",
"definition": "http://hl7.org/fhir/profiles/ImagingStudy",
"type": "token",
"documentation": "DICOM class type (0008,0016)"
},
{
"name": "size",
"definition": "http://hl7.org/fhir/profiles/ImagingStudy",
"type": "number",
"documentation": "The size of the image in MB - may include > or < in the value"
}
]
},
{
"type": "Immunization",
"profile": {
"reference": "http://hl7.org/fhir/Immunization"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "reaction",
"definition": "http://hl7.org/fhir/profiles/Immunization",
"type": "reference",
"documentation": "Additional information on reaction"
},
{
"name": "requester",
"definition": "http://hl7.org/fhir/profiles/Immunization",
"type": "reference",
"documentation": "The practitioner who ordered the vaccination"
},
{
"name": "dose-sequence",
"definition": "http://hl7.org/fhir/profiles/Immunization",
"type": "number",
"documentation": "What dose number within series?"
},
{
"name": "vaccine-type",
"definition": "http://hl7.org/fhir/profiles/Immunization",
"type": "token",
"documentation": "Vaccine Product Type Administered"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/profiles/Immunization",
"type": "reference",
"documentation": "The service delivery location or facility in which the vaccine was / was to be administered"
},
{
"name": "reason",
"definition": "http://hl7.org/fhir/profiles/Immunization",
"type": "token",
"documentation": "Why immunization occurred"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/Immunization",
"type": "reference",
"documentation": "The subject of the vaccination event / refusal"
},
{
"name": "reaction-date",
"definition": "http://hl7.org/fhir/profiles/Immunization",
"type": "date",
"documentation": "When did reaction start?"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/Immunization",
"type": "date",
"documentation": "Vaccination Administration / Refusal Date"
},
{
"name": "lot-number",
"definition": "http://hl7.org/fhir/profiles/Immunization",
"type": "string",
"documentation": "Vaccine Lot Number"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Immunization",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "manufacturer",
"definition": "http://hl7.org/fhir/profiles/Immunization",
"type": "reference",
"documentation": "Vaccine Manufacturer"
},
{
"name": "performer",
"definition": "http://hl7.org/fhir/profiles/Immunization",
"type": "reference",
"documentation": "The practitioner who administered the vaccination"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Immunization",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "refused",
"definition": "http://hl7.org/fhir/profiles/Immunization",
"type": "token",
"documentation": "Was immunization refused?"
},
{
"name": "refusal-reason",
"definition": "http://hl7.org/fhir/profiles/Immunization",
"type": "token",
"documentation": "Explanation of refusal / exemption"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/Immunization",
"type": "token",
"documentation": "Business identifier"
}
]
},
{
"type": "ImmunizationRecommendation",
"profile": {
"reference": "http://hl7.org/fhir/ImmunizationRecommendation"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "information",
"definition": "http://hl7.org/fhir/profiles/ImmunizationRecommendation",
"type": "reference",
"documentation": "Patient observations supporting recommendation"
},
{
"name": "dose-sequence",
"definition": "http://hl7.org/fhir/profiles/ImmunizationRecommendation",
"type": "token",
"documentation": "Number of dose within sequence"
},
{
"name": "support",
"definition": "http://hl7.org/fhir/profiles/ImmunizationRecommendation",
"type": "reference",
"documentation": "Past immunizations supporting recommendation"
},
{
"name": "vaccine-type",
"definition": "http://hl7.org/fhir/profiles/ImmunizationRecommendation",
"type": "token",
"documentation": "Vaccine recommendation applies to"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/ImmunizationRecommendation",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/ImmunizationRecommendation",
"type": "token",
"documentation": "Vaccine administration status"
},
{
"name": "dose-number",
"definition": "http://hl7.org/fhir/profiles/ImmunizationRecommendation",
"type": "number",
"documentation": "Recommended dose number"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/ImmunizationRecommendation",
"type": "reference",
"documentation": "Who this profile is for"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/ImmunizationRecommendation",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/ImmunizationRecommendation",
"type": "date",
"documentation": "Date recommendation created"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/ImmunizationRecommendation",
"type": "token",
"documentation": "Business identifier"
}
]
},
{
"type": "List",
"profile": {
"reference": "http://hl7.org/fhir/List"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "source",
"definition": "http://hl7.org/fhir/profiles/List",
"type": "reference",
"documentation": "Who and/or what defined the list contents"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/List",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/List",
"type": "reference",
"documentation": "If all resources have the same subject"
},
{
"name": "item",
"definition": "http://hl7.org/fhir/profiles/List",
"type": "reference",
"documentation": "Actual entry"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/List",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/profiles/List",
"type": "token",
"documentation": "What the purpose of this list is"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/List",
"type": "date",
"documentation": "When the list was prepared"
},
{
"name": "empty-reason",
"definition": "http://hl7.org/fhir/profiles/List",
"type": "token",
"documentation": "Why list is empty"
}
]
},
{
"type": "Location",
"profile": {
"reference": "http://hl7.org/fhir/Location"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "near",
"definition": "http://hl7.org/fhir/profiles/Location",
"type": "token",
"documentation": "The coordinates expressed as [lat],[long] (using KML, see notes) to find locations near to (servers may search using a square rather than a circle for efficiency)"
},
{
"name": "partof",
"definition": "http://hl7.org/fhir/profiles/Location",
"type": "reference",
"documentation": "The location of which this location is a part"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Location",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/Location",
"type": "token",
"documentation": "Searches for locations with a specific kind of status"
},
{
"name": "address",
"definition": "http://hl7.org/fhir/profiles/Location",
"type": "string",
"documentation": "A (part of the) address of the location"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/profiles/Location",
"type": "string",
"documentation": "A (portion of the) name of the location"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Location",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "near-distance",
"definition": "http://hl7.org/fhir/profiles/Location",
"type": "token",
"documentation": "A distance quantity to limit the near search to locations within a specific distance"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/profiles/Location",
"type": "token",
"documentation": "A code for the type of location"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/Location",
"type": "token",
"documentation": "Unique code or number identifying the location to its users"
}
]
},
{
"type": "Media",
"profile": {
"reference": "http://hl7.org/fhir/Media"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Media",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/Media",
"type": "reference",
"documentation": "Who/What this Media is a record of"
},
{
"name": "subtype",
"definition": "http://hl7.org/fhir/profiles/Media",
"type": "token",
"documentation": "The type of acquisition equipment/process"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Media",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "view",
"definition": "http://hl7.org/fhir/profiles/Media",
"type": "token",
"documentation": "Imaging view e.g Lateral or Antero-posterior"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/Media",
"type": "date",
"documentation": "When the media was taken/recorded (end)"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/profiles/Media",
"type": "token",
"documentation": "photo | video | audio"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/Media",
"type": "token",
"documentation": "Identifier(s) for the image"
},
{
"name": "operator",
"definition": "http://hl7.org/fhir/profiles/Media",
"type": "reference",
"documentation": "The person who generated the image"
}
]
},
{
"type": "Medication",
"profile": {
"reference": "http://hl7.org/fhir/Medication"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "content",
"definition": "http://hl7.org/fhir/profiles/Medication",
"type": "reference",
"documentation": "A product in the package"
},
{
"name": "form",
"definition": "http://hl7.org/fhir/profiles/Medication",
"type": "token",
"documentation": "powder | tablets | carton +"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Medication",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "container",
"definition": "http://hl7.org/fhir/profiles/Medication",
"type": "token",
"documentation": "E.g. box, vial, blister-pack"
},
{
"name": "manufacturer",
"definition": "http://hl7.org/fhir/profiles/Medication",
"type": "reference",
"documentation": "Manufacturer of the item"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/profiles/Medication",
"type": "string",
"documentation": "Common / Commercial name"
},
{
"name": "ingredient",
"definition": "http://hl7.org/fhir/profiles/Medication",
"type": "reference",
"documentation": "The product contained"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Medication",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/profiles/Medication",
"type": "token",
"documentation": "Codes that identify this medication"
}
]
},
{
"type": "MedicationAdministration",
"profile": {
"reference": "http://hl7.org/fhir/MedicationAdministration"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "medication",
"definition": "http://hl7.org/fhir/profiles/MedicationAdministration",
"type": "reference",
"documentation": "Return administrations of this medication"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/profiles/MedicationAdministration",
"type": "reference",
"documentation": "The identity of a patient to list administrations for"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/MedicationAdministration",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/MedicationAdministration",
"type": "token",
"documentation": "MedicationAdministration event status (for example one of active/paused/completed/nullified)"
},
{
"name": "prescription",
"definition": "http://hl7.org/fhir/profiles/MedicationAdministration",
"type": "reference",
"documentation": "The identity of a prescription to list administrations from"
},
{
"name": "device",
"definition": "http://hl7.org/fhir/profiles/MedicationAdministration",
"type": "reference",
"documentation": "Return administrations with this administration device identity"
},
{
"name": "notgiven",
"definition": "http://hl7.org/fhir/profiles/MedicationAdministration",
"type": "token",
"documentation": "Administrations that were not made"
},
{
"name": "whengiven",
"definition": "http://hl7.org/fhir/profiles/MedicationAdministration",
"type": "date",
"documentation": "Date of administration"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/MedicationAdministration",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/profiles/MedicationAdministration",
"type": "reference",
"documentation": "Return administrations that share this encounter"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/MedicationAdministration",
"type": "token",
"documentation": "Return administrations with this external identity"
}
]
},
{
"type": "MedicationDispense",
"profile": {
"reference": "http://hl7.org/fhir/MedicationDispense"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "medication",
"definition": "http://hl7.org/fhir/profiles/MedicationDispense",
"type": "reference",
"documentation": "Returns dispenses of this medicine"
},
{
"name": "prescription",
"definition": "http://hl7.org/fhir/profiles/MedicationDispense",
"type": "reference",
"documentation": "The identity of a prescription to list dispenses from"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/MedicationDispense",
"type": "token",
"documentation": "Status of the dispense"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/profiles/MedicationDispense",
"type": "token",
"documentation": "Return all dispenses of a specific type"
},
{
"name": "destination",
"definition": "http://hl7.org/fhir/profiles/MedicationDispense",
"type": "reference",
"documentation": "Return dispenses that should be sent to a secific destination"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/profiles/MedicationDispense",
"type": "reference",
"documentation": "The identity of a patient to list dispenses for"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/MedicationDispense",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "responsibleparty",
"definition": "http://hl7.org/fhir/profiles/MedicationDispense",
"type": "reference",
"documentation": "Return all dispenses with the specified responsible party"
},
{
"name": "dispenser",
"definition": "http://hl7.org/fhir/profiles/MedicationDispense",
"type": "reference",
"documentation": "Return all dispenses performed by a specific indiividual"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/MedicationDispense",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/MedicationDispense",
"type": "token",
"documentation": "Return dispenses with this external identity"
},
{
"name": "whenhandedover",
"definition": "http://hl7.org/fhir/profiles/MedicationDispense",
"type": "date",
"documentation": "Date when medication handed over to patient (outpatient setting), or supplied to ward or clinic (inpatient setting)"
},
{
"name": "whenprepared",
"definition": "http://hl7.org/fhir/profiles/MedicationDispense",
"type": "date",
"documentation": "Date when medication prepared"
}
]
},
{
"type": "MedicationPrescription",
"profile": {
"reference": "http://hl7.org/fhir/MedicationPrescription"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "medication",
"definition": "http://hl7.org/fhir/profiles/MedicationPrescription",
"type": "reference",
"documentation": "Code for medicine or text in medicine name"
},
{
"name": "datewritten",
"definition": "http://hl7.org/fhir/profiles/MedicationPrescription",
"type": "date",
"documentation": "Return prescriptions written on this date"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/profiles/MedicationPrescription",
"type": "reference",
"documentation": "The identity of a patient to list dispenses for"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/MedicationPrescription",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/MedicationPrescription",
"type": "token",
"documentation": "Status of the prescription"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/MedicationPrescription",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/profiles/MedicationPrescription",
"type": "reference",
"documentation": "Return prescriptions with this encounter identity"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/MedicationPrescription",
"type": "token",
"documentation": "Return prescriptions with this external identity"
}
]
},
{
"type": "MedicationStatement",
"profile": {
"reference": "http://hl7.org/fhir/MedicationStatement"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "medication",
"definition": "http://hl7.org/fhir/profiles/MedicationStatement",
"type": "reference",
"documentation": "Code for medicine or text in medicine name"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/profiles/MedicationStatement",
"type": "reference",
"documentation": "The identity of a patient to list administrations for"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/MedicationStatement",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "device",
"definition": "http://hl7.org/fhir/profiles/MedicationStatement",
"type": "reference",
"documentation": "Return administrations with this administration device identity"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/MedicationStatement",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "when-given",
"definition": "http://hl7.org/fhir/profiles/MedicationStatement",
"type": "date",
"documentation": "Date of administration"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/MedicationStatement",
"type": "token",
"documentation": "Return administrations with this external identity"
}
]
},
{
"type": "MessageHeader",
"profile": {
"reference": "http://hl7.org/fhir/MessageHeader"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/MessageHeader",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/MessageHeader",
"type": "token",
"documentation": "The language of the resource"
}
]
},
{
"type": "Observation",
"profile": {
"reference": "http://hl7.org/fhir/Observation"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "value-string",
"definition": "http://hl7.org/fhir/profiles/Observation",
"type": "string",
"documentation": "The value of the observation, if the value is a string, and also searches in CodeableConcept.text"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/Observation",
"type": "token",
"documentation": "The status of the observation"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/Observation",
"type": "reference",
"documentation": "The subject that the observation is about"
},
{
"name": "value-concept",
"definition": "http://hl7.org/fhir/profiles/Observation",
"type": "token",
"documentation": "The value of the observation, if the value is a CodeableConcept"
},
{
"name": "reliability",
"definition": "http://hl7.org/fhir/profiles/Observation",
"type": "token",
"documentation": "The reliability of the observation"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/Observation",
"type": "date",
"documentation": "Obtained date/time. If the obtained element is a period, a date that falls in the period"
},
{
"name": "name-value-[x]",
"definition": "http://hl7.org/fhir/profiles/Observation",
"type": "composite",
"documentation": "Both name and one of the value parameters"
},
{
"name": "related-target",
"definition": "http://hl7.org/fhir/profiles/Observation",
"type": "reference",
"documentation": "Observation that is related to this one"
},
{
"name": "related",
"definition": "http://hl7.org/fhir/profiles/Observation",
"type": "composite",
"documentation": "Related Observations - search on related-type and related-target together"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Observation",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "specimen",
"definition": "http://hl7.org/fhir/profiles/Observation",
"type": "reference",
"documentation": "Specimen used for this observation"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/profiles/Observation",
"type": "token",
"documentation": "The name of the observation type"
},
{
"name": "related-type",
"definition": "http://hl7.org/fhir/profiles/Observation",
"type": "token",
"documentation": "has-component | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by"
},
{
"name": "performer",
"definition": "http://hl7.org/fhir/profiles/Observation",
"type": "reference",
"documentation": "Who and/or what performed the observation"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Observation",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "value-quantity",
"definition": "http://hl7.org/fhir/profiles/Observation",
"type": "quantity",
"documentation": "The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)"
},
{
"name": "value-date",
"definition": "http://hl7.org/fhir/profiles/Observation",
"type": "date",
"documentation": "The value of the observation, if the value is a Period"
}
]
},
{
"type": "OperationOutcome",
"profile": {
"reference": "http://hl7.org/fhir/OperationOutcome"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/OperationOutcome",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/OperationOutcome",
"type": "token",
"documentation": "The language of the resource"
}
]
},
{
"type": "Order",
"profile": {
"reference": "http://hl7.org/fhir/Order"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "authority",
"definition": "http://hl7.org/fhir/profiles/Order",
"type": "reference",
"documentation": "If required by policy"
},
{
"name": "detail",
"definition": "http://hl7.org/fhir/profiles/Order",
"type": "reference",
"documentation": "What action is being ordered"
},
{
"name": "source",
"definition": "http://hl7.org/fhir/profiles/Order",
"type": "reference",
"documentation": "Who initiated the order"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Order",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/Order",
"type": "reference",
"documentation": "Patient this order is about"
},
{
"name": "when",
"definition": "http://hl7.org/fhir/profiles/Order",
"type": "date",
"documentation": "A formal schedule"
},
{
"name": "target",
"definition": "http://hl7.org/fhir/profiles/Order",
"type": "reference",
"documentation": "Who is intended to fulfill the order"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Order",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "when_code",
"definition": "http://hl7.org/fhir/profiles/Order",
"type": "token",
"documentation": "Code specifies when request should be done. The code may simply be a priority code"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/Order",
"type": "date",
"documentation": "When the order was made"
}
]
},
{
"type": "OrderResponse",
"profile": {
"reference": "http://hl7.org/fhir/OrderResponse"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/OrderResponse",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "fulfillment",
"definition": "http://hl7.org/fhir/profiles/OrderResponse",
"type": "reference",
"documentation": "Details of the outcome of performing the order"
},
{
"name": "request",
"definition": "http://hl7.org/fhir/profiles/OrderResponse",
"type": "reference",
"documentation": "The order that this is a response to"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/OrderResponse",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/profiles/OrderResponse",
"type": "token",
"documentation": "pending | review | rejected | error | accepted | cancelled | replaced | aborted | complete"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/OrderResponse",
"type": "date",
"documentation": "When the response was made"
},
{
"name": "who",
"definition": "http://hl7.org/fhir/profiles/OrderResponse",
"type": "reference",
"documentation": "Who made the response"
}
]
},
{
"type": "Organization",
"profile": {
"reference": "http://hl7.org/fhir/Organization"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "phonetic",
"definition": "http://hl7.org/fhir/profiles/Organization",
"type": "string",
"documentation": "A portion of the organization's name using some kind of phonetic matching algorithm"
},
{
"name": "partof",
"definition": "http://hl7.org/fhir/profiles/Organization",
"type": "reference",
"documentation": "Search all organizations that are part of the given organization"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Organization",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/profiles/Organization",
"type": "string",
"documentation": "A portion of the organization's name"
},
{
"name": "active",
"definition": "http://hl7.org/fhir/profiles/Organization",
"type": "token",
"documentation": "Whether the organization's record is active"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Organization",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/profiles/Organization",
"type": "token",
"documentation": "A code for the type of organization"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/Organization",
"type": "token",
"documentation": "Any identifier for the organization (not the accreditation issuer's identifier)"
}
]
},
{
"type": "Other",
"profile": {
"reference": "http://hl7.org/fhir/Other"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Other",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "created",
"definition": "http://hl7.org/fhir/profiles/Other",
"type": "date",
"documentation": "When created"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/Other",
"type": "reference",
"documentation": "Identifies the"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Other",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/profiles/Other",
"type": "token",
"documentation": "Kind of Resource"
}
]
},
{
"type": "Patient",
"profile": {
"reference": "http://hl7.org/fhir/Patient"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "animal-breed",
"definition": "http://hl7.org/fhir/profiles/Patient",
"type": "token",
"documentation": "The breed for animal patients"
},
{
"name": "phonetic",
"definition": "http://hl7.org/fhir/profiles/Patient",
"type": "string",
"documentation": "A portion of either family or given name using some kind of phonetic matching algorithm"
},
{
"name": "link",
"definition": "http://hl7.org/fhir/profiles/Patient",
"type": "reference",
"documentation": "All patients linked to the given patient"
},
{
"name": "provider",
"definition": "http://hl7.org/fhir/profiles/Patient",
"type": "reference",
"documentation": "The organization at which this person is a patient"
},
{
"name": "animal-species",
"definition": "http://hl7.org/fhir/profiles/Patient",
"type": "token",
"documentation": "The species for animal patients"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Patient",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "given",
"definition": "http://hl7.org/fhir/profiles/Patient",
"type": "string",
"documentation": "A portion of the given name of the patient"
},
{
"name": "address",
"definition": "http://hl7.org/fhir/profiles/Patient",
"type": "string",
"documentation": "An address in any kind of address/part of the patient"
},
{
"name": "family",
"definition": "http://hl7.org/fhir/profiles/Patient",
"type": "string",
"documentation": "A portion of the family name of the patient"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/profiles/Patient",
"type": "string",
"documentation": "A portion of either family or given name of the patient"
},
{
"name": "telecom",
"definition": "http://hl7.org/fhir/profiles/Patient",
"type": "string",
"documentation": "The value in any kind of telecom details of the patient"
},
{
"name": "birthdate",
"definition": "http://hl7.org/fhir/profiles/Patient",
"type": "date",
"documentation": "The patient's date of birth"
},
{
"name": "active",
"definition": "http://hl7.org/fhir/profiles/Patient",
"type": "token",
"documentation": "Whether the patient record is active"
},
{
"name": "gender",
"definition": "http://hl7.org/fhir/profiles/Patient",
"type": "token",
"documentation": "Gender of the patient"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Patient",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "language",
"definition": "http://hl7.org/fhir/profiles/Patient",
"type": "token",
"documentation": "Language code (irrespective of use value)"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/Patient",
"type": "token",
"documentation": "A patient identifier"
}
]
},
{
"type": "Practitioner",
"profile": {
"reference": "http://hl7.org/fhir/Practitioner"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "organization",
"definition": "http://hl7.org/fhir/profiles/Practitioner",
"type": "reference",
"documentation": "The identity of the organization the practitioner represents / acts on behalf of"
},
{
"name": "phonetic",
"definition": "http://hl7.org/fhir/profiles/Practitioner",
"type": "string",
"documentation": "A portion of either family or given name using some kind of phonetic matching algorithm"
},
{
"name": "given",
"definition": "http://hl7.org/fhir/profiles/Practitioner",
"type": "string",
"documentation": "A portion of the given name"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Practitioner",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "address",
"definition": "http://hl7.org/fhir/profiles/Practitioner",
"type": "string",
"documentation": "An address in any kind of address/part"
},
{
"name": "family",
"definition": "http://hl7.org/fhir/profiles/Practitioner",
"type": "string",
"documentation": "A portion of the family name"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/profiles/Practitioner",
"type": "string",
"documentation": "A portion of either family or given name"
},
{
"name": "telecom",
"definition": "http://hl7.org/fhir/profiles/Practitioner",
"type": "string",
"documentation": "The value in any kind of contact"
},
{
"name": "gender",
"definition": "http://hl7.org/fhir/profiles/Practitioner",
"type": "token",
"documentation": "Gender of the practitioner"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Practitioner",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/Practitioner",
"type": "token",
"documentation": "A practitioner's Identifier"
}
]
},
{
"type": "Procedure",
"profile": {
"reference": "http://hl7.org/fhir/Procedure"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Procedure",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/Procedure",
"type": "reference",
"documentation": "The identity of a patient to list procedures for"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Procedure",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/Procedure",
"type": "date",
"documentation": "The date the procedure was performed on"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/profiles/Procedure",
"type": "token",
"documentation": "Type of procedure"
}
]
},
{
"type": "Profile",
"profile": {
"reference": "http://hl7.org/fhir/Profile"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/Profile",
"type": "token",
"documentation": "The current status of the profile"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/profiles/Profile",
"type": "token",
"documentation": "A code for the profile in the format uri::code (server may choose to do subsumption)"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/Profile",
"type": "date",
"documentation": "The profile publication date"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/profiles/Profile",
"type": "token",
"documentation": "Type of resource that is constrained in the profile"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/profiles/Profile",
"type": "token",
"documentation": "The version identifier of the profile"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/profiles/Profile",
"type": "string",
"documentation": "Name of the publisher of the profile"
},
{
"name": "extension",
"definition": "http://hl7.org/fhir/profiles/Profile",
"type": "token",
"documentation": "An extension code (use or definition)"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Profile",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "valueset",
"definition": "http://hl7.org/fhir/profiles/Profile",
"type": "reference",
"documentation": "A vocabulary binding code"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/profiles/Profile",
"type": "string",
"documentation": "Text search in the description of the profile"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/profiles/Profile",
"type": "string",
"documentation": "Name of the profile"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Profile",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/Profile",
"type": "token",
"documentation": "The identifier of the profile"
}
]
},
{
"type": "Provenance",
"profile": {
"reference": "http://hl7.org/fhir/Provenance"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Provenance",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/profiles/Provenance",
"type": "reference",
"documentation": "Where the activity occurred, if relevant"
},
{
"name": "start",
"definition": "http://hl7.org/fhir/profiles/Provenance",
"type": "date",
"documentation": "Starting time with inclusive boundary"
},
{
"name": "partytype",
"definition": "http://hl7.org/fhir/profiles/Provenance",
"type": "token",
"documentation": "e.g. Resource | Person | Application | Record | Document +"
},
{
"name": "target",
"definition": "http://hl7.org/fhir/profiles/Provenance",
"type": "reference",
"documentation": "Target resource(s) (usually version specific)"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Provenance",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "party",
"definition": "http://hl7.org/fhir/profiles/Provenance",
"type": "token",
"documentation": "Identity of agent (urn or url)"
},
{
"name": "end",
"definition": "http://hl7.org/fhir/profiles/Provenance",
"type": "date",
"documentation": "End time with inclusive boundary, if not ongoing"
}
]
},
{
"type": "Query",
"profile": {
"reference": "http://hl7.org/fhir/Query"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "response",
"definition": "http://hl7.org/fhir/profiles/Query",
"type": "token",
"documentation": "Links response to source query"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Query",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Query",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/Query",
"type": "token",
"documentation": "Links query and its response(s)"
}
]
},
{
"type": "Questionnaire",
"profile": {
"reference": "http://hl7.org/fhir/Questionnaire"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "author",
"definition": "http://hl7.org/fhir/profiles/Questionnaire",
"type": "reference",
"documentation": "The author of the questionnaire"
},
{
"name": "authored",
"definition": "http://hl7.org/fhir/profiles/Questionnaire",
"type": "date",
"documentation": "When the questionnaire was authored"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Questionnaire",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/Questionnaire",
"type": "token",
"documentation": "The status of the questionnaire"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/Questionnaire",
"type": "reference",
"documentation": "The subject of the questionnaire"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/profiles/Questionnaire",
"type": "token",
"documentation": "Name of the questionnaire"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Questionnaire",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/profiles/Questionnaire",
"type": "reference",
"documentation": "Encounter during which questionnaire was authored"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/Questionnaire",
"type": "token",
"documentation": "An identifier for the questionnaire"
}
]
},
{
"type": "RelatedPerson",
"profile": {
"reference": "http://hl7.org/fhir/RelatedPerson"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/profiles/RelatedPerson",
"type": "reference",
"documentation": "The patient this person is related to"
},
{
"name": "phonetic",
"definition": "http://hl7.org/fhir/profiles/RelatedPerson",
"type": "string",
"documentation": "A portion of name using some kind of phonetic matching algorithm"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/RelatedPerson",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "address",
"definition": "http://hl7.org/fhir/profiles/RelatedPerson",
"type": "string",
"documentation": "An address in any kind of address/part"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/profiles/RelatedPerson",
"type": "string",
"documentation": "A portion of name in any name part"
},
{
"name": "telecom",
"definition": "http://hl7.org/fhir/profiles/RelatedPerson",
"type": "string",
"documentation": "The value in any kind of contact"
},
{
"name": "gender",
"definition": "http://hl7.org/fhir/profiles/RelatedPerson",
"type": "token",
"documentation": "Gender of the person"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/RelatedPerson",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/RelatedPerson",
"type": "token",
"documentation": "A patient Identifier"
}
]
},
{
"type": "SecurityEvent",
"profile": {
"reference": "http://hl7.org/fhir/SecurityEvent"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "site",
"definition": "http://hl7.org/fhir/profiles/SecurityEvent",
"type": "token",
"documentation": "Logical source location within the enterprise"
},
{
"name": "desc",
"definition": "http://hl7.org/fhir/profiles/SecurityEvent",
"type": "string",
"documentation": "Instance-specific descriptor for Object"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/profiles/SecurityEvent",
"type": "token",
"documentation": "Type/identifier of event"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/SecurityEvent",
"type": "date",
"documentation": "Time when the event occurred on source"
},
{
"name": "reference",
"definition": "http://hl7.org/fhir/profiles/SecurityEvent",
"type": "reference",
"documentation": "Specific instance of resource (e.g. versioned)"
},
{
"name": "identity",
"definition": "http://hl7.org/fhir/profiles/SecurityEvent",
"type": "token",
"documentation": "Specific instance of object (e.g. versioned)"
},
{
"name": "altid",
"definition": "http://hl7.org/fhir/profiles/SecurityEvent",
"type": "token",
"documentation": "Alternative User id e.g. authentication"
},
{
"name": "patientid",
"definition": "http://hl7.org/fhir/profiles/SecurityEvent",
"type": "token",
"documentation": "The id of the patient (one of multiple kinds of participations)"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/SecurityEvent",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "source",
"definition": "http://hl7.org/fhir/profiles/SecurityEvent",
"type": "token",
"documentation": "The id of source where event originated"
},
{
"name": "address",
"definition": "http://hl7.org/fhir/profiles/SecurityEvent",
"type": "token",
"documentation": "Identifier for the network access point of the user device"
},
{
"name": "subtype",
"definition": "http://hl7.org/fhir/profiles/SecurityEvent",
"type": "token",
"documentation": "More specific type/id for the event"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/profiles/SecurityEvent",
"type": "string",
"documentation": "Human-meaningful name for the user"
},
{
"name": "action",
"definition": "http://hl7.org/fhir/profiles/SecurityEvent",
"type": "token",
"documentation": "Type of action performed during the event"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/SecurityEvent",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "object-type",
"definition": "http://hl7.org/fhir/profiles/SecurityEvent",
"type": "token",
"documentation": "Object type being audited"
},
{
"name": "user",
"definition": "http://hl7.org/fhir/profiles/SecurityEvent",
"type": "token",
"documentation": "Unique identifier for the user"
}
]
},
{
"type": "Specimen",
"profile": {
"reference": "http://hl7.org/fhir/Specimen"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Specimen",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/profiles/Specimen",
"type": "reference",
"documentation": "The subject of the specimen"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Specimen",
"type": "token",
"documentation": "The language of the resource"
}
]
},
{
"type": "Substance",
"profile": {
"reference": "http://hl7.org/fhir/Substance"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "substance",
"definition": "http://hl7.org/fhir/profiles/Substance",
"type": "reference",
"documentation": "A component of the substance"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Substance",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "quantity",
"definition": "http://hl7.org/fhir/profiles/Substance",
"type": "number",
"documentation": "Amount of substance in the package"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Substance",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/profiles/Substance",
"type": "token",
"documentation": "The type of the substance"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/Substance",
"type": "token",
"documentation": "Identifier of the package/container"
},
{
"name": "expiry",
"definition": "http://hl7.org/fhir/profiles/Substance",
"type": "date",
"documentation": "When no longer valid to use"
}
]
},
{
"type": "Supply",
"profile": {
"reference": "http://hl7.org/fhir/Supply"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/profiles/Supply",
"type": "reference",
"documentation": "Patient for whom the item is supplied"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/Supply",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/Supply",
"type": "token",
"documentation": "requested | dispensed | received | failed | cancelled"
},
{
"name": "dispenseid",
"definition": "http://hl7.org/fhir/profiles/Supply",
"type": "token",
"documentation": "External identifier"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/Supply",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/Supply",
"type": "token",
"documentation": "Unique identifier"
},
{
"name": "supplier",
"definition": "http://hl7.org/fhir/profiles/Supply",
"type": "reference",
"documentation": "Dispenser"
},
{
"name": "kind",
"definition": "http://hl7.org/fhir/profiles/Supply",
"type": "token",
"documentation": "The kind of supply (central, non-stock, etc)"
},
{
"name": "dispensestatus",
"definition": "http://hl7.org/fhir/profiles/Supply",
"type": "token",
"documentation": "in progress | dispensed | abandoned"
}
]
},
{
"type": "ValueSet",
"profile": {
"reference": "http://hl7.org/fhir/ValueSet"
},
"operation": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "system",
"definition": "http://hl7.org/fhir/profiles/ValueSet",
"type": "token",
"documentation": "The system for any codes defined by this value set"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/profiles/ValueSet",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/profiles/ValueSet",
"type": "token",
"documentation": "The status of the value set"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/profiles/ValueSet",
"type": "string",
"documentation": "Text search in the description of the value set"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/profiles/ValueSet",
"type": "string",
"documentation": "The name of the value set"
},
{
"name": "_language",
"definition": "http://hl7.org/fhir/profiles/ValueSet",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/profiles/ValueSet",
"type": "token",
"documentation": "A code defined in the value set"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/profiles/ValueSet",
"type": "date",
"documentation": "The value set publication date"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/profiles/ValueSet",
"type": "token",
"documentation": "The identifier of the value set"
},
{
"name": "reference",
"definition": "http://hl7.org/fhir/profiles/ValueSet",
"type": "token",
"documentation": "A code system included or excluded in the value set or an imported value set"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/profiles/ValueSet",
"type": "string",
"documentation": "Name of the publisher of the value set"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/profiles/ValueSet",
"type": "token",
"documentation": "The version identifier of the value set"
}
]
}
],
"operation": [
{
"code": "transaction"
},
{
"code": "history-system"
},
{
"code": "search-system"
}
]
}
]
},
"summary": "<div><h2>Base FHIR Conformance Statement (Full)</h2><p>This is the base conformance statement for FHIR. It represents a server that provides the full set of functionality defined by FHIR. It is provided to use as a template for system designers to build their own conformance statements from</p><table><tr><td>Mode</td><td>server</td></tr><tr><td>Description</td><td>All the functionality defined in FHIR</td></tr><tr><td>Transaction</td><td>y</td></tr><tr><td>System History</td><td>y</td></tr><tr><td>System Search</td><td>y</td></tr></table><table><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th><b>Read</b></th><th><b>V-Read</b></th><th><b>Search</b></th><th><b>Update</b></th><th><b>Updates</b></th><th><b>Create</b></th><th><b>Delete</b></th><th><b>History</b></th></tr><tr><td>AdverseReaction</td><td><a href=\"http://hl7.org/fhir/AdverseReaction\">http://hl7.org/fhir/AdverseReaction</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Alert</td><td><a href=\"http://hl7.org/fhir/Alert\">http://hl7.org/fhir/Alert</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>AllergyIntolerance</td><td><a href=\"http://hl7.org/fhir/AllergyIntolerance\">http://hl7.org/fhir/AllergyIntolerance</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>CarePlan</td><td><a href=\"http://hl7.org/fhir/CarePlan\">http://hl7.org/fhir/CarePlan</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Composition</td><td><a href=\"http://hl7.org/fhir/Composition\">http://hl7.org/fhir/Composition</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>ConceptMap</td><td><a href=\"http://hl7.org/fhir/ConceptMap\">http://hl7.org/fhir/ConceptMap</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Condition</td><td><a href=\"http://hl7.org/fhir/Condition\">http://hl7.org/fhir/Condition</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Conformance</td><td><a href=\"http://hl7.org/fhir/Conformance\">http://hl7.org/fhir/Conformance</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Device</td><td><a href=\"http://hl7.org/fhir/Device\">http://hl7.org/fhir/Device</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>DeviceObservationReport</td><td><a href=\"http://hl7.org/fhir/DeviceObservationReport\">http://hl7.org/fhir/DeviceObservationReport</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>DiagnosticOrder</td><td><a href=\"http://hl7.org/fhir/DiagnosticOrder\">http://hl7.org/fhir/DiagnosticOrder</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>DiagnosticReport</td><td><a href=\"http://hl7.org/fhir/DiagnosticReport\">http://hl7.org/fhir/DiagnosticReport</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>DocumentManifest</td><td><a href=\"http://hl7.org/fhir/DocumentManifest\">http://hl7.org/fhir/DocumentManifest</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>DocumentReference</td><td><a href=\"http://hl7.org/fhir/DocumentReference\">http://hl7.org/fhir/DocumentReference</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Encounter</td><td><a href=\"http://hl7.org/fhir/Encounter\">http://hl7.org/fhir/Encounter</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>FamilyHistory</td><td><a href=\"http://hl7.org/fhir/FamilyHistory\">http://hl7.org/fhir/FamilyHistory</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Group</td><td><a href=\"http://hl7.org/fhir/Group\">http://hl7.org/fhir/Group</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>ImagingStudy</td><td><a href=\"http://hl7.org/fhir/ImagingStudy\">http://hl7.org/fhir/ImagingStudy</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Immunization</td><td><a href=\"http://hl7.org/fhir/Immunization\">http://hl7.org/fhir/Immunization</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>ImmunizationRecommendation</td><td><a href=\"http://hl7.org/fhir/ImmunizationRecommendation\">http://hl7.org/fhir/ImmunizationRecommendation</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>List</td><td><a href=\"http://hl7.org/fhir/List\">http://hl7.org/fhir/List</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Location</td><td><a href=\"http://hl7.org/fhir/Location\">http://hl7.org/fhir/Location</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Media</td><td><a href=\"http://hl7.org/fhir/Media\">http://hl7.org/fhir/Media</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Medication</td><td><a href=\"http://hl7.org/fhir/Medication\">http://hl7.org/fhir/Medication</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>MedicationAdministration</td><td><a href=\"http://hl7.org/fhir/MedicationAdministration\">http://hl7.org/fhir/MedicationAdministration</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>MedicationDispense</td><td><a href=\"http://hl7.org/fhir/MedicationDispense\">http://hl7.org/fhir/MedicationDispense</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>MedicationPrescription</td><td><a href=\"http://hl7.org/fhir/MedicationPrescription\">http://hl7.org/fhir/MedicationPrescription</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>MedicationStatement</td><td><a href=\"http://hl7.org/fhir/MedicationStatement\">http://hl7.org/fhir/MedicationStatement</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>MessageHeader</td><td><a href=\"http://hl7.org/fhir/MessageHeader\">http://hl7.org/fhir/MessageHeader</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Observation</td><td><a href=\"http://hl7.org/fhir/Observation\">http://hl7.org/fhir/Observation</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>OperationOutcome</td><td><a href=\"http://hl7.org/fhir/OperationOutcome\">http://hl7.org/fhir/OperationOutcome</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Order</td><td><a href=\"http://hl7.org/fhir/Order\">http://hl7.org/fhir/Order</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>OrderResponse</td><td><a href=\"http://hl7.org/fhir/OrderResponse\">http://hl7.org/fhir/OrderResponse</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Organization</td><td><a href=\"http://hl7.org/fhir/Organization\">http://hl7.org/fhir/Organization</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Other</td><td><a href=\"http://hl7.org/fhir/Other\">http://hl7.org/fhir/Other</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Patient</td><td><a href=\"http://hl7.org/fhir/Patient\">http://hl7.org/fhir/Patient</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Practitioner</td><td><a href=\"http://hl7.org/fhir/Practitioner\">http://hl7.org/fhir/Practitioner</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Procedure</td><td><a href=\"http://hl7.org/fhir/Procedure\">http://hl7.org/fhir/Procedure</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Profile</td><td><a href=\"http://hl7.org/fhir/Profile\">http://hl7.org/fhir/Profile</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Provenance</td><td><a href=\"http://hl7.org/fhir/Provenance\">http://hl7.org/fhir/Provenance</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Query</td><td><a href=\"http://hl7.org/fhir/Query\">http://hl7.org/fhir/Query</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Questionnaire</td><td><a href=\"http://hl7.org/fhir/Questionnaire\">http://hl7.org/fhir/Questionnaire</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>RelatedPerson</td><td><a href=\"http://hl7.org/fhir/RelatedPerson\">http://hl7.org/fhir/RelatedPerson</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>SecurityEvent</td><td><a href=\"http://hl7.org/fhir/SecurityEvent\">http://hl7.org/fhir/SecurityEvent</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Specimen</td><td><a href=\"http://hl7.org/fhir/Specimen\">http://hl7.org/fhir/Specimen</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Substance</td><td><a href=\"http://hl7.org/fhir/Substance\">http://hl7.org/fhir/Substance</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Supply</td><td><a href=\"http://hl7.org/fhir/Supply\">http://hl7.org/fhir/Supply</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>ValueSet</td><td><a href=\"http://hl7.org/fhir/ValueSet\">http://hl7.org/fhir/ValueSet</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr></table></div>"
},
{
"title": "\"conformance-base2\" - to help with system development",
"id": "http://hl7.org/fhir/conformance/conformance-base2",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/conformance/conformance-base2"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Conformance",
"text": {
"status": "generated",
"div": "<div><h2>Base FHIR Conformance Statement (Empty)</h2><p>This is the base conformance statement for FHIR. It represents a server that provides the none of the functionality defined by FHIR. It is provided to use as a template for system designers to build their own conformance statements from. A conformance profile has to contain something, so this contains a read of a Conformance Statement</p><table><tr><td>Mode</td><td>server</td></tr><tr><td>Description</td><td>An empty conformance statement</td></tr><tr><td>Transaction</td><td></td></tr><tr><td>System History</td><td></td></tr><tr><td>System Search</td><td></td></tr></table><table><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th><b>Read</b></th><th><b>V-Read</b></th><th><b>Search</b></th><th><b>Update</b></th><th><b>Updates</b></th><th><b>Create</b></th><th><b>Delete</b></th><th><b>History</b></th></tr><tr><td>Conformance</td><td>y</td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr></table></div>"
},
"identifier": "http://hl7.org/fhir/conformance-base2",
"version": "0.0.82.2943",
"name": "Base FHIR Conformance Statement (Empty)",
"publisher": "FHIR Project Team",
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
],
"description": "This is the base conformance statement for FHIR. It represents a server that provides the none of the functionality defined by FHIR. It is provided to use as a template for system designers to build their own conformance statements from. A conformance profile has to contain something, so this contains a read of a Conformance Statement",
"status": "draft",
"date": "2014-09-30T18:08:29.499+10:00",
"fhirVersion": "0.0.82",
"acceptUnknown": false,
"format": [
"xml",
"json"
],
"rest": [
{
"mode": "server",
"documentation": "An empty conformance statement",
"resource": [
{
"type": "Conformance",
"operation": [
{
"code": "read"
}
]
}
]
}
]
},
"summary": "<div><h2>Base FHIR Conformance Statement (Empty)</h2><p>This is the base conformance statement for FHIR. It represents a server that provides the none of the functionality defined by FHIR. It is provided to use as a template for system designers to build their own conformance statements from. A conformance profile has to contain something, so this contains a read of a Conformance Statement</p><table><tr><td>Mode</td><td>server</td></tr><tr><td>Description</td><td>An empty conformance statement</td></tr><tr><td>Transaction</td><td></td></tr><tr><td>System History</td><td></td></tr><tr><td>System Search</td><td></td></tr></table><table><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th><b>Read</b></th><th><b>V-Read</b></th><th><b>Search</b></th><th><b>Update</b></th><th><b>Updates</b></th><th><b>Create</b></th><th><b>Delete</b></th><th><b>History</b></th></tr><tr><td>Conformance</td><td>y</td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr></table></div>"
},
{
"title": "\"adversereaction\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/adversereaction",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/adversereaction.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"Records an unexpected reaction suspected to be related to the exposure of the reaction subject to a substance.\" class=\"dict\" href=\"adversereaction-definitions.html#AdverseReaction\"><b>AdverseReaction</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"This records identifiers associated with this reaction that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).\" class=\"dict\" href=\"adversereaction-definitions.html#AdverseReaction.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">External Ids for this adverse reaction</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"The date (and possibly time) when the reaction began.\" class=\"dict\" href=\"adversereaction-definitions.html#AdverseReaction.date\"><b>date</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When the reaction occurred</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The subject of the adverse reaction.\" class=\"dict\" href=\"adversereaction-definitions.html#AdverseReaction.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Who had the reaction</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"If true, indicates that no reaction occurred (this element modifies the meaning of other elements)\" class=\"dict\" href=\"adversereaction-definitions.html#AdverseReaction.didNotOccurFlag\"><span style=\"text-decoration: underline\"><b>didNotOccurFlag</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Indicates lack of reaction</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identifies the individual responsible for the information in the reaction record.\" class=\"dict\" href=\"adversereaction-definitions.html#AdverseReaction.recorder\"><b>recorder</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Who recorded the reaction</span><span style=\"color: Gray\"> --></span></recorder>\r\n <<a title=\"The signs and symptoms that were observed as part of the reaction.\" class=\"dict\" href=\"adversereaction-definitions.html#AdverseReaction.symptom\"><b>symptom</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> What was reaction? --></span>\r\n <<a title=\"Indicates the specific sign or symptom that was observed.\" class=\"dict\" href=\"adversereaction-definitions.html#AdverseReaction.symptom.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://apps.who.int/classifications/icd10/browse/2010/en.html\">E.g. Rash, vomiting</a></span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"The severity of the sign or symptom.\" class=\"dict\" href=\"adversereaction-definitions.html#AdverseReaction.symptom.severity\"><b>severity</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"reactionSeverity.html\">severe | serious | moderate | minor</a></span><span style=\"color: Gray\"> --></span>\r\n </symptom>\r\n <<a title=\"An exposure to a substance that preceded a reaction occurrence.\" class=\"dict\" href=\"adversereaction-definitions.html#AdverseReaction.exposure\"><b>exposure</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Suspected substance --></span>\r\n <<a title=\"Identifies the initial date of the exposure that is suspected to be related to the reaction.\" class=\"dict\" href=\"adversereaction-definitions.html#AdverseReaction.exposure.date\"><b>date</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When the exposure occurred</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The type of exposure: Drug Administration, Immunization, Coincidental.\" class=\"dict\" href=\"adversereaction-definitions.html#AdverseReaction.exposure.type\"><b>type</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"exposureType.html\">drugadmin | immuniz | coincidental</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A statement of how confident that the recorder was that this exposure caused the reaction.\" class=\"dict\" href=\"adversereaction-definitions.html#AdverseReaction.exposure.causalityExpectation\"><b>causalityExpectation</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"causalityExpectation.html\">likely | unlikely | confirmed | unknown</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Substance that is presumed to have caused the adverse reaction.\" class=\"dict\" href=\"adversereaction-definitions.html#AdverseReaction.exposure.substance\"><b>substance</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"substance.html#Substance\">Substance</a>)</span> <span style=\"color: navy\">Presumed causative substance</span><span style=\"color: Gray\"> --></span></substance>\r\n </exposure>\r\n</AdverseReaction>\r\n</pre></div>"
},
"name": "adversereaction",
"publisher": "FHIR Project",
"description": "Basic Profile. Records an unexpected reaction suspected to be related to the exposure of the reaction subject to a substance.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage Adverse Reaction resources are used to provide information about specific reactions to a substance. These are normally associated with an AllergyIntolerance resource, but can be reported on their own when no assumption of further reactions is being made, or when specific events are being described.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "AdverseReaction",
"publish": true,
"element": [
{
"path": "AdverseReaction",
"definition": {
"short": "Specific reactions to a substance",
"formal": "Records an unexpected reaction suspected to be related to the exposure of the reaction subject to a substance.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Observation[classCode=OBS, moodCode=EVN]"
},
{
"identity": "v2",
"map": "IAM-11-Onset Date (Does not allow for IAM-12-Onset Date Text)"
}
]
}
},
{
"path": "AdverseReaction.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "AdverseReaction.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "AdverseReaction.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "AdverseReaction.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "AdverseReaction.identifier",
"definition": {
"short": "External Ids for this adverse reaction",
"formal": "This records identifiers associated with this reaction that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
}
},
{
"path": "AdverseReaction.date",
"definition": {
"short": "When the reaction occurred",
"formal": "The date (and possibly time) when the reaction began.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "effectiveTime"
}
]
}
},
{
"path": "AdverseReaction.subject",
"definition": {
"short": "Who had the reaction",
"formal": "The subject of the adverse reaction.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "participation[typeCode=SBJ]"
},
{
"identity": "v2",
"map": "PID-3-Patient ID List"
}
]
}
},
{
"path": "AdverseReaction.didNotOccurFlag",
"definition": {
"short": "Indicates lack of reaction",
"formal": "If true, indicates that no reaction occurred.",
"comments": "Note that the normal case is false, which is a double negative - it's not true that this reaction did not occur. The normal case is to assert that a reaction did happen.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "actionNegationInd"
}
]
}
},
{
"path": "AdverseReaction.recorder",
"definition": {
"short": "Who recorded the reaction",
"formal": "Identifies the individual responsible for the information in the reaction record.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "participation[typeCode=AUT]"
},
{
"identity": "v2",
"map": "IAM-14-Reported By (if patient) / IAM-18-Statused By Person (if practitioner)"
}
]
}
},
{
"path": "AdverseReaction.symptom",
"definition": {
"short": "What was reaction?",
"formal": "The signs and symptoms that were observed as part of the reaction.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=<<symptom>>]"
}
]
}
},
{
"path": "AdverseReaction.symptom.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "AdverseReaction.symptom.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "AdverseReaction.symptom.code",
"definition": {
"short": "E.g. Rash, vomiting",
"formal": "Indicates the specific sign or symptom that was observed.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "SymptomType",
"isExtensible": true,
"conformance": "preferred",
"referenceUri": "http://apps.who.int/classifications/icd10/browse/2010/en"
},
"mapping": [
{
"identity": "rim",
"map": "value"
},
{
"identity": "v2",
"map": "IAR-1"
}
]
}
},
{
"path": "AdverseReaction.symptom.severity",
"definition": {
"short": "severe | serious | moderate | minor",
"formal": "The severity of the sign or symptom.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "ReactionSeverity",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/reactionSeverity"
}
},
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=<<severity>>].value"
},
{
"identity": "v2",
"map": "AL1-4-Allergy Severity Code / IAM-4-Allergy Severity Code"
}
]
}
},
{
"path": "AdverseReaction.exposure",
"definition": {
"short": "Suspected substance",
"formal": "An exposure to a substance that preceded a reaction occurrence.",
"comments": "Multiple repetitions are used to indicate multiple potential causes for the reaction.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=SAS].target[classCode=EXPOS, moodCode=EVN]"
}
]
}
},
{
"path": "AdverseReaction.exposure.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "AdverseReaction.exposure.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "AdverseReaction.exposure.date",
"definition": {
"short": "When the exposure occurred",
"formal": "Identifies the initial date of the exposure that is suspected to be related to the reaction.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "effectiveTime"
},
{
"identity": "v2",
"map": "(V2 does not define distinct concepts of exposure date and reaction date)"
}
]
}
},
{
"path": "AdverseReaction.exposure.type",
"definition": {
"short": "drugadmin | immuniz | coincidental",
"formal": "The type of exposure: Drug Administration, Immunization, Coincidental.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "ExposureType",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/exposureType"
}
},
"mapping": [
{
"identity": "rim",
"map": "code"
}
]
}
},
{
"path": "AdverseReaction.exposure.causalityExpectation",
"definition": {
"short": "likely | unlikely | confirmed | unknown",
"formal": "A statement of how confident that the recorder was that this exposure caused the reaction.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "CausalityExpectation",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/causalityExpectation"
}
},
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=<<ReactionRelatedness>, ].value\n\nNote: Observation also needs to have a subject of the Adverse Reaction itself (i.e. it's expressing relatedness of exposure & reaction)"
},
{
"identity": "v2",
"map": "IAM-17-Allergy Clinical Status Code"
}
]
}
},
{
"path": "AdverseReaction.exposure.substance",
"definition": {
"short": "Presumed causative substance",
"formal": "Substance that is presumed to have caused the adverse reaction.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Substance"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "participation[typeCode=EXPAGNT]"
},
{
"identity": "v2",
"map": "AL1-3 / IAM-3 Allergen Code/Mnemonic/Description"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "date",
"type": "date",
"documentation": "The date of the reaction",
"xpath": "f:AdverseReaction/f:date"
},
{
"name": "subject",
"type": "reference",
"documentation": "The subject that the sensitivity is about",
"xpath": "f:AdverseReaction/f:subject"
},
{
"name": "substance",
"type": "reference",
"documentation": "The name or code of the substance that produces the sensitivity",
"xpath": "f:AdverseReaction/f:exposure/f:substance"
},
{
"name": "symptom",
"type": "token",
"documentation": "One of the symptoms of the reaction",
"xpath": "f:AdverseReaction/f:symptom/f:code"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"Records an unexpected reaction suspected to be related to the exposure of the reaction subject to a substance.\" class=\"dict\" href=\"adversereaction-definitions.html#AdverseReaction\"><b>AdverseReaction</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"This records identifiers associated with this reaction that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).\" class=\"dict\" href=\"adversereaction-definitions.html#AdverseReaction.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">External Ids for this adverse reaction</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"The date (and possibly time) when the reaction began.\" class=\"dict\" href=\"adversereaction-definitions.html#AdverseReaction.date\"><b>date</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When the reaction occurred</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The subject of the adverse reaction.\" class=\"dict\" href=\"adversereaction-definitions.html#AdverseReaction.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Who had the reaction</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"If true, indicates that no reaction occurred (this element modifies the meaning of other elements)\" class=\"dict\" href=\"adversereaction-definitions.html#AdverseReaction.didNotOccurFlag\"><span style=\"text-decoration: underline\"><b>didNotOccurFlag</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Indicates lack of reaction</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identifies the individual responsible for the information in the reaction record.\" class=\"dict\" href=\"adversereaction-definitions.html#AdverseReaction.recorder\"><b>recorder</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Who recorded the reaction</span><span style=\"color: Gray\"> --></span></recorder>\r\n <<a title=\"The signs and symptoms that were observed as part of the reaction.\" class=\"dict\" href=\"adversereaction-definitions.html#AdverseReaction.symptom\"><b>symptom</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> What was reaction? --></span>\r\n <<a title=\"Indicates the specific sign or symptom that was observed.\" class=\"dict\" href=\"adversereaction-definitions.html#AdverseReaction.symptom.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://apps.who.int/classifications/icd10/browse/2010/en.html\">E.g. Rash, vomiting</a></span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"The severity of the sign or symptom.\" class=\"dict\" href=\"adversereaction-definitions.html#AdverseReaction.symptom.severity\"><b>severity</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"reactionSeverity.html\">severe | serious | moderate | minor</a></span><span style=\"color: Gray\"> --></span>\r\n </symptom>\r\n <<a title=\"An exposure to a substance that preceded a reaction occurrence.\" class=\"dict\" href=\"adversereaction-definitions.html#AdverseReaction.exposure\"><b>exposure</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Suspected substance --></span>\r\n <<a title=\"Identifies the initial date of the exposure that is suspected to be related to the reaction.\" class=\"dict\" href=\"adversereaction-definitions.html#AdverseReaction.exposure.date\"><b>date</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When the exposure occurred</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The type of exposure: Drug Administration, Immunization, Coincidental.\" class=\"dict\" href=\"adversereaction-definitions.html#AdverseReaction.exposure.type\"><b>type</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"exposureType.html\">drugadmin | immuniz | coincidental</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A statement of how confident that the recorder was that this exposure caused the reaction.\" class=\"dict\" href=\"adversereaction-definitions.html#AdverseReaction.exposure.causalityExpectation\"><b>causalityExpectation</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"causalityExpectation.html\">likely | unlikely | confirmed | unknown</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Substance that is presumed to have caused the adverse reaction.\" class=\"dict\" href=\"adversereaction-definitions.html#AdverseReaction.exposure.substance\"><b>substance</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"substance.html#Substance\">Substance</a>)</span> <span style=\"color: navy\">Presumed causative substance</span><span style=\"color: Gray\"> --></span></substance>\r\n </exposure>\r\n</AdverseReaction>\r\n</pre></div>"
},
{
"title": "\"alert\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/alert",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/alert.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"Prospective warnings of potential issues when providing care to the patient.\" class=\"dict\" href=\"alert-definitions.html#Alert\"><b>Alert</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Identifier assigned to the alert for external use (outside the FHIR environment).\" class=\"dict\" href=\"alert-definitions.html#Alert.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Business identifier</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Allows an alert to be divided into different categories like clinical, administrative etc.\" class=\"dict\" href=\"alert-definitions.html#Alert.category\"><b>category</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Clinical, administrative, etc.</span><span style=\"color: Gray\"> --></span></category>\r\n <<a title=\"Supports basic workflow.\" class=\"dict\" href=\"alert-definitions.html#Alert.status\"><b>status</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"alert-status.html\">active | inactive | entered in error</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The person who this alert concerns.\" class=\"dict\" href=\"alert-definitions.html#Alert.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Who is alert about?</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"The person or device that created the alert.\" class=\"dict\" href=\"alert-definitions.html#Alert.author\"><b>author</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"patient.html#Patient\">Patient</a>|<a href=\"device.html#Device\">Device</a>)</span> <span style=\"color: navy\">Alert creator</span><span style=\"color: Gray\"> --></span></author>\r\n <<a title=\"The textual component of the alert to display to the user.\" class=\"dict\" href=\"alert-definitions.html#Alert.note\"><b>note</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Text of alert</span><span style=\"color: Gray\"> --></span>\r\n</Alert>\r\n</pre></div>"
},
"name": "alert",
"publisher": "FHIR Project",
"description": "Basic Profile. Prospective warnings of potential issues when providing care to the patient.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage The Alert resource provides a single interface for managing clinical and administrative facts that need to be brought to the attention of users of clinical systems. Examples can include many things. Patient's posing particular risks (falls, physical violence), patient's needing special accomodations (hard of hearing, use easy-open caps), administrative concerns (verify postal address, pre-payment required) or any other situation that needs to be brought to attention within the context of a particular workflow. (The workflow relevant to the issue can be identified by the category element.) \r\n\r\nUsually, resources specific to particular types of issues (health conditions, allergies, active medications will be used to communicate those issues. However, in some cases, particularly important information (a latex or severe food allergy) migt be highlighted as an Alert as well as the more typical resource.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"structure": [
{
"type": "Alert",
"publish": true,
"element": [
{
"path": "Alert",
"definition": {
"short": "Key information to flag to healthcare providers",
"formal": "Prospective warnings of potential issues when providing care to the patient.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Observation[classCode=ISSUE, moodCode=EVN]"
}
]
}
},
{
"path": "Alert.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Alert.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Alert.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "Alert.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "Alert.identifier",
"definition": {
"short": "Business identifier",
"formal": "Identifier assigned to the alert for external use (outside the FHIR environment).",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
}
},
{
"path": "Alert.category",
"definition": {
"short": "Clinical, administrative, etc.",
"formal": "Allows an alert to be divided into different categories like clinical, administrative etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
}
},
{
"path": "Alert.status",
"definition": {
"short": "active | inactive | entered in error",
"formal": "Supports basic workflow.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "AlertStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/alert-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".status"
}
]
}
},
{
"path": "Alert.subject",
"definition": {
"short": "Who is alert about?",
"formal": "The person who this alert concerns.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=PAT]"
}
]
}
},
{
"path": "Alert.author",
"definition": {
"short": "Alert creator",
"formal": "The person or device that created the alert.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
}
]
}
},
{
"path": "Alert.note",
"definition": {
"short": "Text of alert",
"formal": "The textual component of the alert to display to the user.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".value"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "subject",
"type": "reference",
"documentation": "The identity of a subject to list alerts for",
"xpath": "f:Alert/f:subject"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"Prospective warnings of potential issues when providing care to the patient.\" class=\"dict\" href=\"alert-definitions.html#Alert\"><b>Alert</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Identifier assigned to the alert for external use (outside the FHIR environment).\" class=\"dict\" href=\"alert-definitions.html#Alert.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Business identifier</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Allows an alert to be divided into different categories like clinical, administrative etc.\" class=\"dict\" href=\"alert-definitions.html#Alert.category\"><b>category</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Clinical, administrative, etc.</span><span style=\"color: Gray\"> --></span></category>\r\n <<a title=\"Supports basic workflow.\" class=\"dict\" href=\"alert-definitions.html#Alert.status\"><b>status</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"alert-status.html\">active | inactive | entered in error</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The person who this alert concerns.\" class=\"dict\" href=\"alert-definitions.html#Alert.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Who is alert about?</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"The person or device that created the alert.\" class=\"dict\" href=\"alert-definitions.html#Alert.author\"><b>author</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"patient.html#Patient\">Patient</a>|<a href=\"device.html#Device\">Device</a>)</span> <span style=\"color: navy\">Alert creator</span><span style=\"color: Gray\"> --></span></author>\r\n <<a title=\"The textual component of the alert to display to the user.\" class=\"dict\" href=\"alert-definitions.html#Alert.note\"><b>note</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Text of alert</span><span style=\"color: Gray\"> --></span>\r\n</Alert>\r\n</pre></div>"
},
{
"title": "\"allergyintolerance\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/allergyintolerance",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/allergyintolerance.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"Indicates the patient has a susceptibility to an adverse reaction upon exposure to a specified substance.\" class=\"dict\" href=\"allergyintolerance-definitions.html#AllergyIntolerance\"><b>AllergyIntolerance</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"This records identifiers associated with this allergy/intolerance concern that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).\" class=\"dict\" href=\"allergyintolerance-definitions.html#AllergyIntolerance.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">External Ids for this item</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Criticality of the sensitivity.\" class=\"dict\" href=\"allergyintolerance-definitions.html#AllergyIntolerance.criticality\"><b>criticality</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"criticality.html\">fatal | high | medium | low</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Type of the sensitivity.\" class=\"dict\" href=\"allergyintolerance-definitions.html#AllergyIntolerance.sensitivityType\"><b>sensitivityType</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"sensitivitytype.html\">allergy | intolerance | unknown</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Date when the sensitivity was recorded.\" class=\"dict\" href=\"allergyintolerance-definitions.html#AllergyIntolerance.recordedDate\"><b>recordedDate</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When recorded</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Status of the sensitivity (this element modifies the meaning of other elements)\" class=\"dict\" href=\"allergyintolerance-definitions.html#AllergyIntolerance.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"sensitivitystatus.html\">suspected | confirmed | refuted | resolved</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The patient who has the allergy or intolerance.\" class=\"dict\" href=\"allergyintolerance-definitions.html#AllergyIntolerance.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Who the sensitivity is for</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"Indicates who has responsibility for the record.\" class=\"dict\" href=\"allergyintolerance-definitions.html#AllergyIntolerance.recorder\"><b>recorder</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Who recorded the sensitivity</span><span style=\"color: Gray\"> --></span></recorder>\r\n <<a title=\"The substance that causes the sensitivity.\" class=\"dict\" href=\"allergyintolerance-definitions.html#AllergyIntolerance.substance\"><b>substance</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"substance.html#Substance\">Substance</a>)</span> <span style=\"color: navy\">The substance that causes the sensitivity</span><span style=\"color: Gray\"> --></span></substance>\r\n <<a title=\"Reactions associated with the sensitivity.\" class=\"dict\" href=\"allergyintolerance-definitions.html#AllergyIntolerance.reaction\"><b>reaction</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"adversereaction.html#AdverseReaction\">AdverseReaction</a>)</span> <span style=\"color: navy\">Reactions associated with the sensitivity</span><span style=\"color: Gray\"> --></span></reaction>\r\n <<a title=\"Observations that confirm or refute the sensitivity.\" class=\"dict\" href=\"allergyintolerance-definitions.html#AllergyIntolerance.sensitivityTest\"><b>sensitivityTest</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"observation.html#Observation\">Observation</a>)</span> <span style=\"color: navy\">\r\n Observations that confirm or refute</span><span style=\"color: Gray\"> --></span></sensitivityTest>\r\n</AllergyIntolerance>\r\n</pre></div>"
},
"name": "allergyintolerance",
"publisher": "FHIR Project",
"description": "Basic Profile. Indicates the patient has a susceptibility to an adverse reaction upon exposure to a specified substance.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage Allergy/Intolerance resources are used to provide information about adverse sensitivities to substances that lead to physiologic changes that are clinically observable. An adverse sensitivity is defined as: \r\n\r\nA condition expected to result in undesirable physiologic reaction to an amount of a substance that would not produce a reaction in most individuals. The substance is the trigger of an immunologic response that produces the observed physiologic changes, or in some instances nonimmunologic mechanisms that produce clinically identical physiologic changes. The immunologic response might be considered the actual cause of the reaction, but it is exposure to the trigger substance that is clinically observable. \r\n\r\nThis definition excludes clinically identical episodes that may be caused by physical agents, such as heat, cold, sunlight, or vibration, by exercise activity, or by infectious agents. Those conditions caused by physical agents or infectious would be captured on the problem list (List/Condition Resources). The allergy/intolerance list is a list of conditions that represent a propensity unique to this individual for a reaction upon future exposure to a specified substance. \r\n\r\nNote that this specification draws a distinction between the patients condition/problem list and an allergy/intolerance list, even though allergies and intolerances are also conditions. This is because the distinction is a long established clinical workflow, even to patients. Asking an individual \"if they have any problems\" is not going to invoke an account of their past reactions to medications or foods. Instead, they are asked if they \"have any allergies\". An allergy/intolerance is also different in that a potential harm from exposure to an external substance that may be ordered by a provider in the course of their care but is not inherent to exposure to that substance for the general population.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "AllergyIntolerance",
"publish": true,
"element": [
{
"path": "AllergyIntolerance",
"definition": {
"short": "Drug, food, environmental and others",
"formal": "Indicates the patient has a susceptibility to an adverse reaction upon exposure to a specified substance.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Observation[moodCode=EVN, code<AllergyIntolerance]"
}
]
}
},
{
"path": "AllergyIntolerance.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "AllergyIntolerance.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "AllergyIntolerance.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "AllergyIntolerance.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "AllergyIntolerance.identifier",
"definition": {
"short": "External Ids for this item",
"formal": "This records identifiers associated with this allergy/intolerance concern that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
}
},
{
"path": "AllergyIntolerance.criticality",
"definition": {
"short": "fatal | high | medium | low",
"formal": "Criticality of the sensitivity.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "Criticality",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/criticality"
}
},
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"criticality\"].value"
}
]
}
},
{
"path": "AllergyIntolerance.sensitivityType",
"definition": {
"short": "allergy | intolerance | unknown",
"formal": "Type of the sensitivity.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "SensitivityType",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/sensitivitytype"
}
},
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"sensitivity\"].value"
},
{
"identity": "v2",
"map": "IAM-9-Sensitivity to Causative Agent Code"
}
]
}
},
{
"path": "AllergyIntolerance.recordedDate",
"definition": {
"short": "When recorded",
"formal": "Date when the sensitivity was recorded.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
},
{
"identity": "v2",
"map": "IAM-20-Statused at Date/Time"
}
]
}
},
{
"path": "AllergyIntolerance.status",
"definition": {
"short": "suspected | confirmed | refuted | resolved",
"formal": "Status of the sensitivity.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "SensitivityStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/sensitivitystatus"
}
},
"mapping": [
{
"identity": "rim",
"map": ".status (suspected/confirmed differentiated by uncertaintyCode)"
},
{
"identity": "v2",
"map": "IAM-17-Allergy Clinical Status Code"
}
]
}
},
{
"path": "AllergyIntolerance.subject",
"definition": {
"short": "Who the sensitivity is for",
"formal": "The patient who has the allergy or intolerance.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=PAT]"
},
{
"identity": "v2",
"map": "PID-3-Patient ID List"
}
]
}
},
{
"path": "AllergyIntolerance.recorder",
"definition": {
"short": "Who recorded the sensitivity",
"formal": "Indicates who has responsibility for the record.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
},
{
"identity": "v2",
"map": "IAM-14-Reported By (if patient) / IAM-18-Statused By Person (if practitioner)"
}
]
}
},
{
"path": "AllergyIntolerance.substance",
"definition": {
"short": "The substance that causes the sensitivity",
"formal": "The substance that causes the sensitivity.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Substance"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=ADMM]"
},
{
"identity": "v2",
"map": "AL1-3-Allergen Code/Mnemonic/Description / IAM-3-Allergen Code/Mnemonic/Description"
}
]
}
},
{
"path": "AllergyIntolerance.reaction",
"definition": {
"short": "Reactions associated with the sensitivity",
"formal": "Reactions associated with the sensitivity.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/AdverseReaction"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=SPRT].target[classCode=OBS, moodCode=EVN, code<AdverseReaction]"
},
{
"identity": "v2",
"map": "IAM-7-Allergy Unique Identifier (Overloaded concept)"
}
]
}
},
{
"path": "AllergyIntolerance.sensitivityTest",
"definition": {
"short": "Observations that confirm or refute",
"formal": "Observations that confirm or refute the sensitivity.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Observation"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=SPRT].target[classCode=OBS, moodCode=EVN, code<SensitivityTest]"
},
{
"identity": "v2",
"map": "OBX-21-Observation Instance Identifier\n(Subject to Ch7 caveats)"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "date",
"type": "date",
"documentation": "Recorded date/time.",
"xpath": "f:AllergyIntolerance/f:recordedDate"
},
{
"name": "recorder",
"type": "reference",
"documentation": "Who recorded the sensitivity",
"xpath": "f:AllergyIntolerance/f:recorder"
},
{
"name": "status",
"type": "token",
"documentation": "The status of the sensitivity",
"xpath": "f:AllergyIntolerance/f:status"
},
{
"name": "subject",
"type": "reference",
"documentation": "The subject that the sensitivity is about",
"xpath": "f:AllergyIntolerance/f:subject"
},
{
"name": "substance",
"type": "reference",
"documentation": "The name or code of the substance that produces the sensitivity",
"xpath": "f:AllergyIntolerance/f:substance"
},
{
"name": "type",
"type": "token",
"documentation": "The type of sensitivity",
"xpath": "f:AllergyIntolerance/f:sensitivityType"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"Indicates the patient has a susceptibility to an adverse reaction upon exposure to a specified substance.\" class=\"dict\" href=\"allergyintolerance-definitions.html#AllergyIntolerance\"><b>AllergyIntolerance</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"This records identifiers associated with this allergy/intolerance concern that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).\" class=\"dict\" href=\"allergyintolerance-definitions.html#AllergyIntolerance.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">External Ids for this item</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Criticality of the sensitivity.\" class=\"dict\" href=\"allergyintolerance-definitions.html#AllergyIntolerance.criticality\"><b>criticality</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"criticality.html\">fatal | high | medium | low</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Type of the sensitivity.\" class=\"dict\" href=\"allergyintolerance-definitions.html#AllergyIntolerance.sensitivityType\"><b>sensitivityType</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"sensitivitytype.html\">allergy | intolerance | unknown</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Date when the sensitivity was recorded.\" class=\"dict\" href=\"allergyintolerance-definitions.html#AllergyIntolerance.recordedDate\"><b>recordedDate</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When recorded</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Status of the sensitivity (this element modifies the meaning of other elements)\" class=\"dict\" href=\"allergyintolerance-definitions.html#AllergyIntolerance.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"sensitivitystatus.html\">suspected | confirmed | refuted | resolved</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The patient who has the allergy or intolerance.\" class=\"dict\" href=\"allergyintolerance-definitions.html#AllergyIntolerance.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Who the sensitivity is for</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"Indicates who has responsibility for the record.\" class=\"dict\" href=\"allergyintolerance-definitions.html#AllergyIntolerance.recorder\"><b>recorder</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Who recorded the sensitivity</span><span style=\"color: Gray\"> --></span></recorder>\r\n <<a title=\"The substance that causes the sensitivity.\" class=\"dict\" href=\"allergyintolerance-definitions.html#AllergyIntolerance.substance\"><b>substance</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"substance.html#Substance\">Substance</a>)</span> <span style=\"color: navy\">The substance that causes the sensitivity</span><span style=\"color: Gray\"> --></span></substance>\r\n <<a title=\"Reactions associated with the sensitivity.\" class=\"dict\" href=\"allergyintolerance-definitions.html#AllergyIntolerance.reaction\"><b>reaction</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"adversereaction.html#AdverseReaction\">AdverseReaction</a>)</span> <span style=\"color: navy\">Reactions associated with the sensitivity</span><span style=\"color: Gray\"> --></span></reaction>\r\n <<a title=\"Observations that confirm or refute the sensitivity.\" class=\"dict\" href=\"allergyintolerance-definitions.html#AllergyIntolerance.sensitivityTest\"><b>sensitivityTest</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"observation.html#Observation\">Observation</a>)</span> <span style=\"color: navy\">\r\n Observations that confirm or refute</span><span style=\"color: Gray\"> --></span></sensitivityTest>\r\n</AllergyIntolerance>\r\n</pre></div>"
},
{
"title": "\"careplan\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/careplan",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/careplan.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"Describes the intention of how one or more practitioners intend to deliver care for a particular patient for a period of time, possibly limited to care for a specific condition or set of conditions.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan\"><b>CarePlan</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"This records identifiers associated with this care plan that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">External Ids for this plan</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Identifies the patient/subject whose intended care is described by the plan.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.patient\"><b>patient</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Who care plan is for</span><span style=\"color: Gray\"> --></span></patient>\r\n <<a title=\"Indicates whether the plan is currently being acted upon, represents future intentions or is now just historical record (this element modifies the meaning of other elements)\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"care-plan-status.html\">planned | active | completed</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Indicates when the plan did (or is intended to) come into effect and end.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.period\"><b>period</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">Time period plan covers</span><span style=\"color: Gray\"> --></span></period>\r\n <<a title=\"Identifies the most recent date on which the plan has been revised.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.modified\"><b>modified</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When last updated</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.concern\"><b>concern</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"condition.html#Condition\">Condition</a>)</span> <span style=\"color: navy\">Health issues this plan addresses</span><span style=\"color: Gray\"> --></span></concern>\r\n <<a title=\"Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.participant\"><b>participant</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Who's involved in plan? --></span>\r\n <<a title=\"Indicates specific responsibility of an individual within the care plan. E.g. "Primary physician", "Team coordinator", "Caregiver", etc.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.participant.role\"><b>role</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Type of involvement</span><span style=\"color: Gray\"> --></span></role>\r\n <<a title=\"The specific person or organization who is participating/expected to participate in the care plan.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.participant.member\"><b>member</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"relatedperson.html#RelatedPerson\">RelatedPerson</a>|<a href=\"patient.html#Patient\">Patient</a>|<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">Who is involved</span><span style=\"color: Gray\"> --></span></member>\r\n </participant>\r\n <<a title=\"Describes the intended objective(s) of carrying out the Care Plan.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.goal\"><b>goal</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Desired outcome of plan --></span>\r\n <<a title=\"Human-readable description of a specific desired objective of the care plan.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.goal.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">What's the desired outcome?</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Indicates whether the goal has been reached and is still considered relevant.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.goal.status\"><b>status</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"care-plan-goal-status.html\">in progress | achieved | sustaining | cancelled</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Any comments related to the goal.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.goal.notes\"><b>notes</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Comments about the goal</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The identified conditions that this goal relates to - the condition that caused it to be created, or that it is intended to address.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.goal.concern\"><b>concern</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"condition.html#Condition\">Condition</a>)</span> <span style=\"color: navy\">Health issues this goal addresses</span><span style=\"color: Gray\"> --></span></concern>\r\n </goal>\r\n <<a title=\"Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.activity\"><b>activity</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Action to occur as part of plan --></span>\r\n <<a title=\"Internal reference that identifies the goals that this activity is intended to contribute towards meeting.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.activity.goal\"><b>goal</b></a> value="[<span style=\"color: darkgreen\"><a href=\"references.html#idref\">idref</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: navy\">Goals this activity relates to</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identifies what progress is being made for the specific activity.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.activity.status\"><b>status</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"care-plan-activity-status.html\">not started | scheduled | in progress | on hold | completed | cancelled</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"If true, indicates that the described activity is one that must NOT be engaged in when following the plan (this element modifies the meaning of other elements)\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.activity.prohibited\"><span style=\"text-decoration: underline\"><b>prohibited</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Do NOT do</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Resources that describe follow-on actions resulting from the plan, such as drug prescriptions, encounter records, appointments, etc.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.activity.actionResulting\"><b>actionResulting</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">Appointments, orders, etc.</span><span style=\"color: Gray\"> --></span></actionResulting>\r\n <<a title=\"Notes about the execution of the activity.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.activity.notes\"><b>notes</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Comments about the activity</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The details of the proposed activity represented in a specific resource.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.activity.detail\"><b>detail</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-3: Only provide a detail reference, or a simple detail summary\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"procedure.html#Procedure\">Procedure</a>|<a href=\"medicationprescription.html#MedicationPrescription\">MedicationPrescription</a>|<a href=\"diagnosticorder.html#DiagnosticOrder\">DiagnosticOrder</a>|\r\n <a href=\"encounter.html#Encounter\">Encounter</a>)</span> <span style=\"color: navy\">Activity details defined in specific resource</span><span style=\"color: Gray\"> --></span></detail>\r\n <<a title=\"A simple summary of details suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.activity.simple\"><b>simple</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-3: Only provide a detail reference, or a simple detail summary\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> Activity details summarised here --></span>\r\n <<a title=\"High-level categorization of the type of activity in a care plan.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.activity.simple.category\"><b>category</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"care-plan-activity-category.html\">diet | drug | encounter | observation | procedure | supply | other</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Detailed description of the type of activity. E.g. What lab test, what procedure, what kind of encounter.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.activity.simple.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Detail type of activity</span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"The period, timing or frequency upon which the described activity is to occur.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.activity.simple.timing_x_\"><b>timing[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Schedule\">Schedule</a>|<a href=\"datatypes.html#Period\">Period</a>|<a href=\"datatypes.html#string\">string</a></span> <span style=\"color: navy\">When activity is to occur</span><span style=\"color: Gray\"> --></span></timing[x]>\r\n <<a title=\"Identifies the facility where the activity will occur. E.g. home, hospital, specific clinic, etc.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.activity.simple.location\"><b>location</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">Where it should happen</span><span style=\"color: Gray\"> --></span></location>\r\n <<a title=\"Identifies who's expected to be involved in the activity.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.activity.simple.performer\"><b>performer</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"organization.html#Organization\">Organization</a>|<a href=\"relatedperson.html#RelatedPerson\">RelatedPerson</a>|<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">\r\n Who's responsible?</span><span style=\"color: Gray\"> --></span></performer>\r\n <<a title=\"Identifies the food, drug or other product being consumed or supplied in the activity.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.activity.simple.product\"><b>product</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"medication.html#Medication\">Medication</a>|<a href=\"substance.html#Substance\">Substance</a>)</span> <span style=\"color: navy\">What's administered/supplied</span><span style=\"color: Gray\"> --></span></product>\r\n <<a title=\"Identifies the quantity expected to be consumed in a given day.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.activity.simple.dailyAmount\"><b>dailyAmount</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: DailyDose can only be specified if activity category is drug or food\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">How much consumed/day?</span><span style=\"color: Gray\"> --></span></dailyAmount>\r\n <<a title=\"Identifies the quantity expected to be supplied.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.activity.simple.quantity\"><b>quantity</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: Quantity can only be specified if activity category is supply\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">How much is administered/supplied/consumed</span><span style=\"color: Gray\"> --></span></quantity>\r\n <<a title=\"This provides a textual description of constraints on the activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.activity.simple.details\"><b>details</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Extra info on activity occurrence</span><span style=\"color: Gray\"> --></span>\r\n </simple>\r\n </activity>\r\n <<a title=\"General notes about the care plan not covered elsewhere.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.notes\"><b>notes</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Comments about the plan</span><span style=\"color: Gray\"> --></span>\r\n</CarePlan>\r\n</pre></div>"
},
"name": "careplan",
"publisher": "FHIR Project",
"description": "Basic Profile. Describes the intention of how one or more practitioners intend to deliver care for a particular patient for a period of time, possibly limited to care for a specific condition or set of conditions.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage Care Plans are used in many of areas of healthcare with a variety of scopes. They can be as simple as a general practitioner keeping track of when their patient is next due for a tetanus immunization through to a detailed plan for an oncology patient covering diet, chemotherapy, radiation, lab work and counseling with detailed timing relationships, pre-conditions and goals. \r\n\r\nThis resource takes an intermediate approach. It captures basic details about who is involved and what actions are intended without dealing in discrete data about dependencies and timing relationships. These can be supported where necessary using the extension mechanisms. \r\n\r\nComments are welcome about the appropriateness of the proposed level of granularity, whether it's too much detail for what most systems need, or not sufficient for common essential use cases.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "CarePlan",
"publish": true,
"element": [
{
"path": "CarePlan",
"definition": {
"short": "Healthcare plan for patient",
"formal": "Describes the intention of how one or more practitioners intend to deliver care for a particular patient for a period of time, possibly limited to care for a specific condition or set of conditions.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Act[classCode=PCPR, moodCode=INT]"
}
]
}
},
{
"path": "CarePlan.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "CarePlan.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "CarePlan.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "CarePlan.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "CarePlan.identifier",
"definition": {
"short": "External Ids for this plan",
"formal": "This records identifiers associated with this care plan that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
}
},
{
"path": "CarePlan.patient",
"definition": {
"short": "Who care plan is for",
"formal": "Identifies the patient/subject whose intended care is described by the plan.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PAT].role[classCode=PAT]"
},
{
"identity": "v2",
"map": "PID-3-patient ID list"
}
]
}
},
{
"path": "CarePlan.status",
"definition": {
"short": "planned | active | completed",
"formal": "Indicates whether the plan is currently being acted upon, represents future intentions or is now just historical record.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "CarePlanStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/care-plan-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode\nplanned = new\nactive = active\ncompleted = completed"
},
{
"identity": "v2",
"map": "PTH-5-pathway life cycle status"
}
]
}
},
{
"path": "CarePlan.period",
"definition": {
"short": "Time period plan covers",
"formal": "Indicates when the plan did (or is intended to) come into effect and end.",
"comments": "Any activities scheduled as part of the plan should be constrained to the specified period.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "v2",
"map": "GOL-7-goal established date/time / GOL-8-expected goal achieve date/time"
}
]
}
},
{
"path": "CarePlan.modified",
"definition": {
"short": "When last updated",
"formal": "Identifies the most recent date on which the plan has been revised.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
},
{
"identity": "v2",
"map": "PTH-6-change pathway life cycle status date/time"
}
]
}
},
{
"path": "CarePlan.concern",
"definition": {
"short": "Health issues this plan addresses",
"formal": "Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Condition"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".actRelationship[typeCode=SUBJ].target[classCode=CONC, moodCode=EVN]"
},
{
"identity": "v2",
"map": "PRB-4-Problem instance ID"
}
]
}
},
{
"path": "CarePlan.participant",
"definition": {
"short": "Who's involved in plan?",
"formal": "Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PFM]"
},
{
"identity": "v2",
"map": "REL (REL.4 is always the Patient) ( or PRT?)"
}
]
}
},
{
"path": "CarePlan.participant.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "CarePlan.participant.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "CarePlan.participant.role",
"definition": {
"short": "Type of involvement",
"formal": "Indicates specific responsibility of an individual within the care plan. E.g. \"Primary physician\", \"Team coordinator\", \"Caregiver\", etc.",
"comments": "Roles may sometimes be inferred by type of Practitioner. These are relationships that hold only within the context of the care plan. General relationships should be handled as properties of the Patient resource directly.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "CarePlanParticipantRole",
"isExtensible": true,
"conformance": "preferred",
"description": "Indicates specific responsibility of an individual within the care plan. E.g. \"Primary physician\", \"Team coordinator\", \"Caregiver\", etc."
},
"mapping": [
{
"identity": "rim",
"map": ".functionCode"
},
{
"identity": "v2",
"map": "REL.2 (or PRT-4-participation?)"
}
]
}
},
{
"path": "CarePlan.participant.member",
"definition": {
"short": "Who is involved",
"formal": "The specific person or organization who is participating/expected to participate in the care plan.",
"comments": "Patient only needs to be listed if they have a role other than \"subject of care\".",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/RelatedPerson"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".role"
},
{
"identity": "v2",
"map": "REL.5 (or PRT-5-participation person : ( PRV-4 e {provider participations} ) / PRT-5-participation person : ( PRV-4 e {non-provider person participations} ) / PRT-5-participation person : ( PRV-4 = (patient non-subject of care) ) / PRT-8-participation organization?)"
}
]
}
},
{
"path": "CarePlan.goal",
"definition": {
"short": "Desired outcome of plan",
"formal": "Describes the intended objective(s) of carrying out the Care Plan.",
"comments": "Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode<=OBJ]."
},
{
"identity": "v2",
"map": "GOL.1"
}
]
}
},
{
"path": "CarePlan.goal.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "CarePlan.goal.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "CarePlan.goal.description",
"definition": {
"short": "What's the desired outcome?",
"formal": "Human-readable description of a specific desired objective of the care plan.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".text"
},
{
"identity": "v2",
"map": "GOL-3.2-goal ID.text"
}
]
}
},
{
"path": "CarePlan.goal.status",
"definition": {
"short": "in progress | achieved | sustaining | cancelled",
"formal": "Indicates whether the goal has been reached and is still considered relevant.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "CarePlanGoalStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/care-plan-goal-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode\nin progress = active (classCode = OBJ)\nachieved = complete\nsustaining = active (classCode=OBJC)\ncancelled = aborted"
},
{
"identity": "v2",
"map": "GOL-18-goal life cycle status"
}
]
}
},
{
"path": "CarePlan.goal.notes",
"definition": {
"short": "Comments about the goal",
"formal": "Any comments related to the goal.",
"comments": "May be used for progress notes, concerns or other related information that doesn't actually describe the goal itself.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
},
{
"identity": "v2",
"map": "GOL-16-goal evaluation + NTE?"
}
]
}
},
{
"path": "CarePlan.goal.concern",
"definition": {
"short": "Health issues this goal addresses",
"formal": "The identified conditions that this goal relates to - the condition that caused it to be created, or that it is intended to address.",
"comments": "The concerns do not also need to be listed under CarePlan.concern, but may be.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Condition"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=SUBJ].target[classCode=CONC]"
}
]
}
},
{
"path": "CarePlan.activity",
"definition": {
"short": "Action to occur as part of plan",
"formal": "Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target"
}
]
}
},
{
"path": "CarePlan.activity.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "CarePlan.activity.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "CarePlan.activity.goal",
"definition": {
"short": "Goals this activity relates to",
"formal": "Internal reference that identifies the goals that this activity is intended to contribute towards meeting.",
"min": 0,
"max": "*",
"type": [
{
"code": "idref"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode<=OBJ]."
}
]
}
},
{
"path": "CarePlan.activity.status",
"definition": {
"short": "not started | scheduled | in progress | on hold | completed | cancelled",
"formal": "Identifies what progress is being made for the specific activity.",
"comments": "Some aspects of Status can be inferred based on the resources linked in actionTaken. Note that \"status\" is only as current as the plan was most recently updated.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "CarePlanActivityStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/care-plan-activity-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode\nnot started = new\nscheduled = not started (and fulfillment relationship to appointent)\nin progress = active\non hold = suspended\ncompleted = completed\ncancelled = aborted"
},
{
"identity": "v2",
"map": "ORC-5-order status?"
}
]
}
},
{
"path": "CarePlan.activity.prohibited",
"definition": {
"short": "Do NOT do",
"formal": "If true, indicates that the described activity is one that must NOT be engaged in when following the plan.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "actionNegationInd"
}
]
}
},
{
"path": "CarePlan.activity.actionResulting",
"definition": {
"short": "Appointments, orders, etc.",
"formal": "Resources that describe follow-on actions resulting from the plan, such as drug prescriptions, encounter records, appointments, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Any"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=FLFS].source"
}
]
}
},
{
"path": "CarePlan.activity.notes",
"definition": {
"short": "Comments about the activity",
"formal": "Notes about the execution of the activity.",
"comments": "Doesn't describe the activity - that goes in details.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
},
{
"identity": "v2",
"map": "NTE?"
}
]
}
},
{
"path": "CarePlan.activity.detail",
"definition": {
"short": "Activity details defined in specific resource",
"formal": "The details of the proposed activity represented in a specific resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Procedure"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/MedicationPrescription"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/DiagnosticOrder"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Encounter"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target"
}
]
}
},
{
"path": "CarePlan.activity.simple",
"definition": {
"short": "Activity details summarised here",
"formal": "A simple summary of details suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc.",
"min": 0,
"max": "1",
"constraint": [
{
"key": "3",
"name": "details by reference, or simple details",
"severity": "error",
"human": "Only provide a detail reference, or a simple detail summary",
"xpath": "not(exists(f:detail)) or not(exists(f:simple))"
},
{
"key": "2",
"name": "quantity for supply",
"severity": "error",
"human": "Quantity can only be specified if activity category is supply",
"xpath": "(f:category/@value=('supply')) = exists(f:quantity)"
},
{
"key": "1",
"name": "dose for food or drug",
"severity": "error",
"human": "DailyDose can only be specified if activity category is drug or food",
"xpath": "(f:category/@value=('drug','diet')) = exists(f:dailyAmount)"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target"
}
]
}
},
{
"path": "CarePlan.activity.simple.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "CarePlan.activity.simple.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "CarePlan.activity.simple.category",
"definition": {
"short": "diet | drug | encounter | observation | procedure | supply | other",
"formal": "High-level categorization of the type of activity in a care plan.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "CarePlanActivityCategory",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/care-plan-activity-category"
}
},
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=LIST].code"
}
]
}
},
{
"path": "CarePlan.activity.simple.code",
"definition": {
"short": "Detail type of activity",
"formal": "Detailed description of the type of activity. E.g. What lab test, what procedure, what kind of encounter.",
"comments": "Tends to be less relevant for activities involving particular products. Codes should not convey negation - use \"prohibited\" instead.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "CarePlanActivityType",
"isExtensible": true,
"conformance": "preferred",
"description": "Detailed description of the type of activity. E.g. What lab test, what procedure, what kind of encounter."
},
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "v2",
"map": "OBR-4-universal service ID / RXE-2-Give Code / RXO-1-Requested Give Code / RXD-2-Dispense/Give Code"
}
]
}
},
{
"path": "CarePlan.activity.simple.timing[x]",
"definition": {
"short": "When activity is to occur",
"formal": "The period, timing or frequency upon which the described activity is to occur.",
"min": 0,
"max": "1",
"type": [
{
"code": "Schedule"
},
{
"code": "Period"
},
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "v2",
"map": "TQ1"
}
]
}
},
{
"path": "CarePlan.activity.simple.location",
"definition": {
"short": "Where it should happen",
"formal": "Identifies the facility where the activity will occur. E.g. home, hospital, specific clinic, etc.",
"comments": "May reference a specific clinical location or may just identify a type of location.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Location"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=LOC].role"
},
{
"identity": "v2",
"map": "OBR-24-diagnostic service section ID (???!!)"
}
]
}
},
{
"path": "CarePlan.activity.simple.performer",
"definition": {
"short": "Who's responsible?",
"formal": "Identifies who's expected to be involved in the activity.",
"comments": "A performer MAY also be a participant in the care plan.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/RelatedPerson"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PFM]"
},
{
"identity": "v2",
"map": "PRT-5-participation person : ( PRV-4 e {provider participations} ) / PRT-5-participation person : ( PRV-4 e {non-provider person participations} ) / PRT-5-participation person : ( PRV-4 = (patient non-subject of care) ) / PRT-8-participation organization"
}
]
}
},
{
"path": "CarePlan.activity.simple.product",
"definition": {
"short": "What's administered/supplied",
"formal": "Identifies the food, drug or other product being consumed or supplied in the activity.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Medication"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Substance"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PRD].role"
},
{
"identity": "v2",
"map": "RXE-2-Give Code / RXO-1-Requested Give Code / RXD-2-Dispense/Give Code"
}
]
}
},
{
"path": "CarePlan.activity.simple.dailyAmount",
"definition": {
"short": "How much consumed/day?",
"formal": "Identifies the quantity expected to be consumed in a given day.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP][classCode=SBADM].doseQuantity"
},
{
"identity": "v2",
"map": "RXO-23-total daily dose / RXE-19-total daily dose / RXD-12-total daily dose"
}
]
}
},
{
"path": "CarePlan.activity.simple.quantity",
"definition": {
"short": "How much is administered/supplied/consumed",
"formal": "Identifies the quantity expected to be supplied.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP][classCode=SPLY].quantity"
},
{
"identity": "v2",
"map": "RXO-11-requested dispense amount / RXE-10-dispense amount / RXD-4-actual dispense amount / RXG-5-give amount-minumum / RXA-6-administered amount / TQ1-2.1-quantity.quantity *and* RXO-12-requested dispense units / RXE-11-dispense units / RXD-5-actual dispense units / RXG-7-give units / RXA-7-administered units / TQ1-2.2-quantity.units"
}
]
}
},
{
"path": "CarePlan.activity.simple.details",
"definition": {
"short": "Extra info on activity occurrence",
"formal": "This provides a textual description of constraints on the activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".text"
},
{
"identity": "v2",
"map": "NTE?"
}
]
}
},
{
"path": "CarePlan.notes",
"definition": {
"short": "Comments about the plan",
"formal": "General notes about the care plan not covered elsewhere.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
},
{
"identity": "v2",
"map": "NTE?"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "activitycode",
"type": "token",
"documentation": "Detail type of activity",
"xpath": "f:CarePlan/f:activity/f:simple/f:code"
},
{
"name": "activitydate",
"type": "date",
"documentation": "Specified date occurs within period specified by CarePlan.activity.timingSchedule",
"xpath": "f:CarePlan/f:activity/f:simple/f:timing[x]"
},
{
"name": "activitydetail",
"type": "reference",
"documentation": "Activity details defined in specific resource",
"xpath": "f:CarePlan/f:activity/f:detail"
},
{
"name": "condition",
"type": "reference",
"documentation": "Health issues this plan addresses",
"xpath": "f:CarePlan/f:concern"
},
{
"name": "date",
"type": "date",
"documentation": "Time period plan covers",
"xpath": "f:CarePlan/f:period"
},
{
"name": "participant",
"type": "reference",
"documentation": "Who is involved",
"xpath": "f:CarePlan/f:participant/f:member"
},
{
"name": "patient",
"type": "reference",
"documentation": "Who care plan is for",
"xpath": "f:CarePlan/f:patient"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"Describes the intention of how one or more practitioners intend to deliver care for a particular patient for a period of time, possibly limited to care for a specific condition or set of conditions.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan\"><b>CarePlan</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"This records identifiers associated with this care plan that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">External Ids for this plan</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Identifies the patient/subject whose intended care is described by the plan.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.patient\"><b>patient</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Who care plan is for</span><span style=\"color: Gray\"> --></span></patient>\r\n <<a title=\"Indicates whether the plan is currently being acted upon, represents future intentions or is now just historical record (this element modifies the meaning of other elements)\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"care-plan-status.html\">planned | active | completed</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Indicates when the plan did (or is intended to) come into effect and end.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.period\"><b>period</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">Time period plan covers</span><span style=\"color: Gray\"> --></span></period>\r\n <<a title=\"Identifies the most recent date on which the plan has been revised.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.modified\"><b>modified</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When last updated</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.concern\"><b>concern</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"condition.html#Condition\">Condition</a>)</span> <span style=\"color: navy\">Health issues this plan addresses</span><span style=\"color: Gray\"> --></span></concern>\r\n <<a title=\"Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.participant\"><b>participant</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Who's involved in plan? --></span>\r\n <<a title=\"Indicates specific responsibility of an individual within the care plan. E.g. "Primary physician", "Team coordinator", "Caregiver", etc.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.participant.role\"><b>role</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Type of involvement</span><span style=\"color: Gray\"> --></span></role>\r\n <<a title=\"The specific person or organization who is participating/expected to participate in the care plan.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.participant.member\"><b>member</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"relatedperson.html#RelatedPerson\">RelatedPerson</a>|<a href=\"patient.html#Patient\">Patient</a>|<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">Who is involved</span><span style=\"color: Gray\"> --></span></member>\r\n </participant>\r\n <<a title=\"Describes the intended objective(s) of carrying out the Care Plan.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.goal\"><b>goal</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Desired outcome of plan --></span>\r\n <<a title=\"Human-readable description of a specific desired objective of the care plan.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.goal.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">What's the desired outcome?</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Indicates whether the goal has been reached and is still considered relevant.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.goal.status\"><b>status</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"care-plan-goal-status.html\">in progress | achieved | sustaining | cancelled</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Any comments related to the goal.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.goal.notes\"><b>notes</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Comments about the goal</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The identified conditions that this goal relates to - the condition that caused it to be created, or that it is intended to address.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.goal.concern\"><b>concern</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"condition.html#Condition\">Condition</a>)</span> <span style=\"color: navy\">Health issues this goal addresses</span><span style=\"color: Gray\"> --></span></concern>\r\n </goal>\r\n <<a title=\"Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.activity\"><b>activity</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Action to occur as part of plan --></span>\r\n <<a title=\"Internal reference that identifies the goals that this activity is intended to contribute towards meeting.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.activity.goal\"><b>goal</b></a> value="[<span style=\"color: darkgreen\"><a href=\"references.html#idref\">idref</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: navy\">Goals this activity relates to</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identifies what progress is being made for the specific activity.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.activity.status\"><b>status</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"care-plan-activity-status.html\">not started | scheduled | in progress | on hold | completed | cancelled</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"If true, indicates that the described activity is one that must NOT be engaged in when following the plan (this element modifies the meaning of other elements)\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.activity.prohibited\"><span style=\"text-decoration: underline\"><b>prohibited</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Do NOT do</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Resources that describe follow-on actions resulting from the plan, such as drug prescriptions, encounter records, appointments, etc.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.activity.actionResulting\"><b>actionResulting</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">Appointments, orders, etc.</span><span style=\"color: Gray\"> --></span></actionResulting>\r\n <<a title=\"Notes about the execution of the activity.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.activity.notes\"><b>notes</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Comments about the activity</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The details of the proposed activity represented in a specific resource.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.activity.detail\"><b>detail</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-3: Only provide a detail reference, or a simple detail summary\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"procedure.html#Procedure\">Procedure</a>|<a href=\"medicationprescription.html#MedicationPrescription\">MedicationPrescription</a>|<a href=\"diagnosticorder.html#DiagnosticOrder\">DiagnosticOrder</a>|\r\n <a href=\"encounter.html#Encounter\">Encounter</a>)</span> <span style=\"color: navy\">Activity details defined in specific resource</span><span style=\"color: Gray\"> --></span></detail>\r\n <<a title=\"A simple summary of details suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.activity.simple\"><b>simple</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-3: Only provide a detail reference, or a simple detail summary\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> Activity details summarised here --></span>\r\n <<a title=\"High-level categorization of the type of activity in a care plan.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.activity.simple.category\"><b>category</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"care-plan-activity-category.html\">diet | drug | encounter | observation | procedure | supply | other</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Detailed description of the type of activity. E.g. What lab test, what procedure, what kind of encounter.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.activity.simple.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Detail type of activity</span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"The period, timing or frequency upon which the described activity is to occur.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.activity.simple.timing_x_\"><b>timing[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Schedule\">Schedule</a>|<a href=\"datatypes.html#Period\">Period</a>|<a href=\"datatypes.html#string\">string</a></span> <span style=\"color: navy\">When activity is to occur</span><span style=\"color: Gray\"> --></span></timing[x]>\r\n <<a title=\"Identifies the facility where the activity will occur. E.g. home, hospital, specific clinic, etc.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.activity.simple.location\"><b>location</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">Where it should happen</span><span style=\"color: Gray\"> --></span></location>\r\n <<a title=\"Identifies who's expected to be involved in the activity.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.activity.simple.performer\"><b>performer</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"organization.html#Organization\">Organization</a>|<a href=\"relatedperson.html#RelatedPerson\">RelatedPerson</a>|<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">\r\n Who's responsible?</span><span style=\"color: Gray\"> --></span></performer>\r\n <<a title=\"Identifies the food, drug or other product being consumed or supplied in the activity.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.activity.simple.product\"><b>product</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"medication.html#Medication\">Medication</a>|<a href=\"substance.html#Substance\">Substance</a>)</span> <span style=\"color: navy\">What's administered/supplied</span><span style=\"color: Gray\"> --></span></product>\r\n <<a title=\"Identifies the quantity expected to be consumed in a given day.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.activity.simple.dailyAmount\"><b>dailyAmount</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: DailyDose can only be specified if activity category is drug or food\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">How much consumed/day?</span><span style=\"color: Gray\"> --></span></dailyAmount>\r\n <<a title=\"Identifies the quantity expected to be supplied.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.activity.simple.quantity\"><b>quantity</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: Quantity can only be specified if activity category is supply\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">How much is administered/supplied/consumed</span><span style=\"color: Gray\"> --></span></quantity>\r\n <<a title=\"This provides a textual description of constraints on the activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.activity.simple.details\"><b>details</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Extra info on activity occurrence</span><span style=\"color: Gray\"> --></span>\r\n </simple>\r\n </activity>\r\n <<a title=\"General notes about the care plan not covered elsewhere.\" class=\"dict\" href=\"careplan-definitions.html#CarePlan.notes\"><b>notes</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Comments about the plan</span><span style=\"color: Gray\"> --></span>\r\n</CarePlan>\r\n</pre></div>"
},
{
"title": "\"composition\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/composition",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/composition.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"A set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement.\" class=\"dict\" href=\"composition-definitions.html#Composition\"><b>Composition</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Logical Identifier for the composition, assigned when created. This identifier stays constant as the composition is changed over time.\" class=\"dict\" href=\"composition-definitions.html#Composition.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">\r\n Logical identifier of composition (version-independent)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"The composition editing time, when the composition was last logically changed by the author.\" class=\"dict\" href=\"composition-definitions.html#Composition.date\"><b>date</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Composition editing time<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.\" class=\"dict\" href=\"composition-definitions.html#Composition.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-doc-codes.html\">Kind of composition (LOINC if possible)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"A categorization for the type of the composition. This may be implied by or derived from the code specified in the Composition Type.\" class=\"dict\" href=\"composition-definitions.html#Composition.class\"><b>class</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-xds-typecodes.html\">Categorization of Composition<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></class>\r\n <<a title=\"Official human-readable label for the composition.\" class=\"dict\" href=\"composition-definitions.html#Composition.title\"><b>title</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Human Readable name/title<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document (this element modifies the meaning of other elements)\" class=\"dict\" href=\"composition-definitions.html#Composition.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"composition-status.html\">preliminary | final | appended | amended | entered in error<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The code specifying the level of confidentiality of the Composition (this element modifies the meaning of other elements)\" class=\"dict\" href=\"composition-definitions.html#Composition.confidentiality\"><span style=\"text-decoration: underline\"><b>confidentiality</b></span></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Coding\">Coding</a></span> <a style=\"color: navy\" href=\"v3/vs/Confidentiality/index.html\">As defined by affinity domain<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a><span style=\"color: Gray\"> --></span></confidentiality>\r\n <<a title=\"Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (I.e. machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).\" class=\"dict\" href=\"composition-definitions.html#Composition.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"group.html#Group\">Group</a>|<a href=\"device.html#Device\">Device</a>|<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">\r\n Who and/or what the composition is about<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"Identifies who is responsible for the information in the composition. (Not necessarily who typed it in.).\" class=\"dict\" href=\"composition-definitions.html#Composition.author\"><b>author</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"device.html#Device\">Device</a>|<a href=\"patient.html#Patient\">Patient</a>|<a href=\"relatedperson.html#RelatedPerson\">RelatedPerson</a>)</span> <span style=\"color: navy\">\r\n Who and/or what authored the composition<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></author>\r\n <<a title=\"A participant who has attested to the accuracy of the composition/document.\" class=\"dict\" href=\"composition-definitions.html#Composition.attester\"><b>attester</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Attests to accuracy of composition<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span> --></span>\r\n <<a title=\"The type of attestation the authenticator offers.\" class=\"dict\" href=\"composition-definitions.html#Composition.attester.mode\"><b>mode</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..*</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"composition-attestation-mode.html\">personal | professional | legal | official<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"When composition was attested by the party.\" class=\"dict\" href=\"composition-definitions.html#Composition.attester.time\"><b>time</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When composition attested<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Who attested the composition in the specified way.\" class=\"dict\" href=\"composition-definitions.html#Composition.attester.party\"><b>party</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">Who attested the composition<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></party>\r\n </attester>\r\n <<a title=\"Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.\" class=\"dict\" href=\"composition-definitions.html#Composition.custodian\"><b>custodian</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">Org which maintains the composition<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></custodian>\r\n <<a title=\"The main event/act/item, such as a colonoscopy or an appendectomy, being documented.\" class=\"dict\" href=\"composition-definitions.html#Composition.event\"><b>event</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> The clinical event/act/item being documented<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span> --></span>\r\n <<a title=\"This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.\" class=\"dict\" href=\"composition-definitions.html#Composition.event.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v3/ActCode/index.html\">Code(s) that apply to the event being documented<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.\" class=\"dict\" href=\"composition-definitions.html#Composition.event.period\"><b>period</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">The period covered by the documentation<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></period>\r\n <<a title=\"Full details for the event(s) the composition/documentation consents.\" class=\"dict\" href=\"composition-definitions.html#Composition.event.detail\"><b>detail</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">Full details for the event(s) the composition consents<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></detail>\r\n </event>\r\n <<a title=\"Describes the clinical encounter or type of care this documentation is associated with.\" class=\"dict\" href=\"composition-definitions.html#Composition.encounter\"><b>encounter</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"encounter.html#Encounter\">Encounter</a>)</span> <span style=\"color: navy\">Context of the conposition<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></encounter>\r\n <<a title=\"The root of the sections that make up the composition.\" class=\"dict\" href=\"composition-definitions.html#Composition.section\"><b>section</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Composition is broken into sections --></span>\r\n <<a title=\"The heading for this particular section. This will be part of the rendered content for the document.\" class=\"dict\" href=\"composition-definitions.html#Composition.section.title\"><b>title</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Label for section</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A code identifying the kind of content contained within the section.\" class=\"dict\" href=\"composition-definitions.html#Composition.section.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-doc-section-codes.html\">Classification of section (recommended)</a></span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"Identifies the primary subject of the section (this element modifies the meaning of other elements)\" class=\"dict\" href=\"composition-definitions.html#Composition.section.subject\"><span style=\"text-decoration: underline\"><b>subject</b></span></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"group.html#Group\">Group</a>|<a href=\"device.html#Device\">Device</a>)</span> <span style=\"color: navy\">If section different to composition</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"Identifies the discrete data that provides the content for the section.\" class=\"dict\" href=\"composition-definitions.html#Composition.section.content\"><b>content</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: A section SHALL have content or one or more sections, but not both.\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">The actual data for the section</span><span style=\"color: Gray\"> --></span></content>\r\n <<a title=\"A nested sub-section within this section.\" class=\"dict\" href=\"composition-definitions.html#Composition.section.section\"><b>section</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: A section SHALL have content or one or more sections, but not both.\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> <span style=\"color: darkgreen\">Content as for Composition.section</span> <span style=\"color: navy\">Nested Section</span><span style=\"color: Gray\"> --></span></section>\r\n </section>\r\n</Composition>\r\n</pre></div>"
},
"name": "composition",
"publisher": "FHIR Project",
"description": "Basic Profile. A set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage A Composition is also the basic structure from which FHIR Documents - immutable bundles with attested narrative - are built. A single logical composition may be associated with a series of derived documents, each of which is a frozen copy of the composition. \r\n\r\nNote: EN 13606 uses the term \"Composition\" to refer to a single commit to an EHR system, and offers some common examples: a consultation note, a progress note, a report or a letter, an investigation report, a prescription form and a set of bedside nursing observations. These logical examples are all valid uses of a Composition resource, but it is not required that all the resources are updated in a single commit.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "cda",
"uri": "http://hl7.org/v3/cda",
"name": "CDA (R2)"
}
],
"structure": [
{
"type": "Composition",
"publish": true,
"element": [
{
"path": "Composition",
"definition": {
"short": "A set of resources composed into a single coherent clinical statement with clinical attestation",
"formal": "A set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement.",
"comments": "While the focus of this specification is on patient-specific clinical statements, this resource can also apply to other healthcare-related statements such as study protocol designs, healthcare invoices and other activities that are not necessarily patient-specific or clinical.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Document[classCode=\"DOC\" and moodCode=\"EVN\" and isNormalAct()]"
},
{
"identity": "cda",
"map": "ClinicalDocument"
}
]
}
},
{
"path": "Composition.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Composition.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Composition.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "Composition.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "Composition.identifier",
"definition": {
"short": "Logical identifier of composition (version-independent)",
"formal": "Logical Identifier for the composition, assigned when created. This identifier stays constant as the composition is changed over time.",
"comments": "See discussion in resource definition for how these relate.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Document.id / Document.setId"
},
{
"identity": "cda",
"map": ".setId"
}
]
}
},
{
"path": "Composition.date",
"definition": {
"short": "Composition editing time",
"formal": "The composition editing time, when the composition was last logically changed by the author.",
"comments": "The Last Modified Date on the composition may be after the date of the document was attested without being changed.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime[type=\"TS\"]"
},
{
"identity": "cda",
"map": ".effectiveTime"
}
]
}
},
{
"path": "Composition.type",
"definition": {
"short": "Kind of composition (LOINC if possible)",
"formal": "Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "DocumentType",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/doc-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": "./code"
},
{
"identity": "cda",
"map": ".code"
}
]
}
},
{
"path": "Composition.class",
"definition": {
"short": "Categorization of Composition",
"formal": "A categorization for the type of the composition. This may be implied by or derived from the code specified in the Composition Type.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "DocumentClass",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/xds-typecodes"
}
},
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"
},
{
"identity": "cda",
"map": "n/a"
}
]
}
},
{
"path": "Composition.title",
"definition": {
"short": "Human Readable name/title",
"formal": "Official human-readable label for the composition.",
"comments": "If compositions do not have a title, the text or a display name of Composition.type (e.g. a \"consultation\" or \"progress note\") can be used in it's place.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./title"
},
{
"identity": "cda",
"map": ".title"
}
]
}
},
{
"path": "Composition.status",
"definition": {
"short": "preliminary | final | appended | amended | entered in error",
"formal": "The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.",
"comments": "If a composition is marked as withdrawn, the compositions/documents in the series, or data from the composition or document series, should never be displayed to a user without being clearly marked as untrustworthy. The flag \"withdrawn\" is why this element is labeled as a modifier of other elements.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "CompositionStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/composition-status"
}
},
"mapping": [
{
"identity": "rim",
"map": "interim: .completionCode=\"IN\" & ./statusCode[isNormalDatatype()]=\"active\";\n\nfinal: .completionCode=\"AU\" && ./statusCode[isNormalDatatype()]=\"complete\" and not(./inboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#CACT\") and moodCode=\"EVN\" and domainMember(\"ReviseComposition\", code) and isNormalAct()]);\n\namended: .completionCode=\"AU\" && ./statusCode[isNormalDatatype()]=\"complete\" and ./inboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#CACT\") and moodCode=\"EVN\" and domainMember(\"ReviseComposition\", code) and isNormalAct() and statusCode=\"completed\"];\n\nwithdrawn : .completionCode=NI && ./statusCode[isNormalDatatype()]=\"obsolete\""
},
{
"identity": "cda",
"map": "n/a"
}
]
}
},
{
"path": "Composition.confidentiality",
"definition": {
"short": "As defined by affinity domain",
"formal": "The code specifying the level of confidentiality of the Composition.",
"comments": "The exact use of this element, and enforcement and issues related to highly sensitive documents are out of scope for FHIR, and delegated to implementation profiles (see security section).",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isModifier": true,
"binding": {
"name": "DocumentConfidentiality",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/v3/vs/Confidentiality"
}
},
"mapping": [
{
"identity": "rim",
"map": ".confidentialityCode"
},
{
"identity": "cda",
"map": ".confidentialityCode"
}
]
}
},
{
"path": "Composition.subject",
"definition": {
"short": "Who and/or what the composition is about",
"formal": "Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (I.e. machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).",
"comments": "For clinical documents, this is usually the patient.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Group"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Location"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=\"SBJ\"].role[typeCode=\"PAT\"]"
},
{
"identity": "cda",
"map": ".recordTarget"
}
]
}
},
{
"path": "Composition.author",
"definition": {
"short": "Who and/or what authored the composition",
"formal": "Identifies who is responsible for the information in the composition. (Not necessarily who typed it in.).",
"min": 1,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/RelatedPerson"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=\"AUT\"].role[classCode=\"ASSIGNED\"]"
},
{
"identity": "cda",
"map": ".author.assignedAuthor"
}
]
}
},
{
"path": "Composition.attester",
"definition": {
"short": "Attests to accuracy of composition",
"formal": "A participant who has attested to the accuracy of the composition/document.",
"comments": "Only list each attester once.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=\"AUTHEN\"].role[classCode=\"ASSIGNED\"]"
},
{
"identity": "cda",
"map": ".authenticator/.legalAuthenticator"
}
]
}
},
{
"path": "Composition.attester.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Composition.attester.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Composition.attester.mode",
"definition": {
"short": "personal | professional | legal | official",
"formal": "The type of attestation the authenticator offers.",
"comments": "Use more than one code where a single attester has more than one mode (professional and legal are often paired).",
"min": 1,
"max": "*",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "CompositionAttestationMode",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/composition-attestation-mode"
}
},
"mapping": [
{
"identity": "rim",
"map": "unique(./modeCode)"
},
{
"identity": "cda",
"map": "implied by .authenticator/.legalAuthenticator"
}
]
}
},
{
"path": "Composition.attester.time",
"definition": {
"short": "When composition attested",
"formal": "When composition was attested by the party.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./time[type=\"TS\" and isNormalDatatype()]"
},
{
"identity": "cda",
"map": ".authenticator.time"
}
]
}
},
{
"path": "Composition.attester.party",
"definition": {
"short": "Who attested the composition",
"formal": "Who attested the composition in the specified way.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./role[classCode=\"ASSIGNED\" and isNormalRole]/player[determinerCode=\"INST\" and classCode=(\"DEV\", \"PSN\") and isNormalEntity()]\nor\n./role[classCode=\"ASSIGNED\" and isNormalRole and not(player)]/scoper[determinerCode=\"INST\" and classCode=\"ORG\" and isNormalEntity()]"
},
{
"identity": "cda",
"map": ".authenticator.assignedEnttty"
}
]
}
},
{
"path": "Composition.custodian",
"definition": {
"short": "Org which maintains the composition",
"formal": "Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.",
"comments": "This is useful when documents are derived from a composition - provides guidance for how to get the latest version of the document. This is optional because knowing this is sometimes not known by the authoring system, and can be inferred by context. However it's important that this information be known when working with a derived document, so providing a custodian is encouraged.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=\"RCV\"].role[classCode=\"CUST\"].scoper[classCode=\"ORG\" and determinerCode=\"INST\"]"
},
{
"identity": "cda",
"map": ".custodian.assignedCustodian"
}
]
}
},
{
"path": "Composition.event",
"definition": {
"short": "The clinical event/act/item being documented",
"formal": "The main event/act/item, such as a colonoscopy or an appendectomy, being documented.",
"comments": "The event needs to be consistent with the type element, though can provide further information if desired.",
"min": 0,
"max": "1",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=\"SUBJ\"].target[classCode<'ACT']"
},
{
"identity": "cda",
"map": ".documentationOf.serviceEvent"
}
]
}
},
{
"path": "Composition.event.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Composition.event.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Composition.event.code",
"definition": {
"short": "Code(s) that apply to the event being documented",
"formal": "This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a \"History and Physical Report\" in which the procedure being documented is necessarily a \"History and Physical\" act.",
"comments": "An event can further specialize the act inherent in the typeCode, such as where it is simply \"Procedure Report\" and the procedure was a \"colonoscopy\". If one or more eventCodes are included, they SHALL NOT conflict with the values inherent in the classCode, practiceSettingCode or typeCode, as such a conflict would create an ambiguous situation. This short list of codes is provided to be used as “key words” for certain types of queries.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "DocumentEventType",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/v3/vs/ActCode"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "cda",
"map": ".code"
}
]
}
},
{
"path": "Composition.event.period",
"definition": {
"short": "The period covered by the documentation",
"formal": "The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "cda",
"map": ".effectiveTime"
}
]
}
},
{
"path": "Composition.event.detail",
"definition": {
"short": "Full details for the event(s) the composition consents",
"formal": "Full details for the event(s) the composition/documentation consents.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Any"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"SUBJ\"].target"
},
{
"identity": "cda",
"map": "n/a"
}
]
}
},
{
"path": "Composition.encounter",
"definition": {
"short": "Context of the conposition",
"formal": "Describes the clinical encounter or type of care this documentation is associated with.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Encounter"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "unique(highest(./outboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()], priorityNumber)/target[moodCode=\"EVN\" and classCode=(\"ENC\", \"PCPR\") and isNormalAct])"
},
{
"identity": "cda",
"map": ".componentOf.encompassingEncounter"
}
]
}
},
{
"path": "Composition.section",
"definition": {
"short": "Composition is broken into sections",
"formal": "The root of the sections that make up the composition.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "2",
"name": "Section Rule",
"severity": "error",
"human": "A section SHALL have content or one or more sections, but not both.",
"xpath": "exists(f:content) != exists(f:section)"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[moodCode=\"EVN\" and classCode=\"DOCSECT\" and isNormalAct]"
},
{
"identity": "cda",
"map": ".component.structuredBody.component.section"
}
]
}
},
{
"path": "Composition.section.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Composition.section.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Composition.section.title",
"definition": {
"short": "Label for section",
"formal": "The heading for this particular section. This will be part of the rendered content for the document.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./title"
},
{
"identity": "cda",
"map": ".title"
}
]
}
},
{
"path": "Composition.section.code",
"definition": {
"short": "Classification of section (recommended)",
"formal": "A code identifying the kind of content contained within the section.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "CompositionSectionType",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/doc-section-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": "./code"
},
{
"identity": "cda",
"map": ".code"
}
]
}
},
{
"path": "Composition.section.subject",
"definition": {
"short": "If section different to composition",
"formal": "Identifies the primary subject of the section.",
"comments": "This is labeled as \"Is Modifier\" because applications SHALL be aware if the subject changes for a particular section.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Group"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "unique(./participation[typeCode=\"SBJ\" and isNormalParticipation]/role[typeCode=\"PAT\"])\nor\nunique(./participation[typeCode=\"SBJ\" and isNormalParticipation]/role[typeCode=\"IDENT\"]/player[determinerCode=\"INST\" and classCode=(\"DEV\", \"ORG\") and isNormalEntity()])"
},
{
"identity": "cda",
"map": ".subject.relatedSubject"
}
]
}
},
{
"path": "Composition.section.content",
"definition": {
"short": "The actual data for the section",
"formal": "Identifies the discrete data that provides the content for the section.",
"comments": "Because composition represent point-in-time snapshots, resource references should either be to a specific version, or made against resources on the same server with full version tracking, so that the correct versions can easily be assembled.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Any"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "unique(./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[moodCode=\"EVN\" and classCode!=\"DOCSECT\" and isNormalAct])"
},
{
"identity": "cda",
"map": "n/a"
}
]
}
},
{
"path": "Composition.section.section",
"definition": {
"short": "Nested Section",
"formal": "A nested sub-section within this section.",
"min": 0,
"max": "*",
"nameReference": "Composition.section",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[moodCode=\"EVN\" and classCode=\"DOCSECT\" and isNormalAct]"
},
{
"identity": "cda",
"map": ".component.section"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "attester",
"type": "reference",
"documentation": "Who attested the composition",
"xpath": "f:Composition/f:attester/f:party"
},
{
"name": "author",
"type": "reference",
"documentation": "Who and/or what authored the composition",
"xpath": "f:Composition/f:author"
},
{
"name": "class",
"type": "token",
"documentation": "Categorization of Composition",
"xpath": "f:Composition/f:class"
},
{
"name": "context",
"type": "token",
"documentation": "Code(s) that apply to the event being documented",
"xpath": "f:Composition/f:event/f:code"
},
{
"name": "date",
"type": "date",
"documentation": "Composition editing time",
"xpath": "f:Composition/f:date"
},
{
"name": "identifier",
"type": "token",
"documentation": "Logical identifier of composition (version-independent)",
"xpath": "f:Composition/f:identifier"
},
{
"name": "section-content",
"type": "reference",
"documentation": "The actual data for the section",
"xpath": "f:Composition/f:section/f:content"
},
{
"name": "section-type",
"type": "token",
"documentation": "Classification of section (recommended)",
"xpath": "f:Composition/f:section/f:code"
},
{
"name": "subject",
"type": "reference",
"documentation": "Who and/or what the composition is about",
"xpath": "f:Composition/f:subject"
},
{
"name": "type",
"type": "token",
"documentation": "Kind of composition (LOINC if possible)",
"xpath": "f:Composition/f:type"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"A set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement.\" class=\"dict\" href=\"composition-definitions.html#Composition\"><b>Composition</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Logical Identifier for the composition, assigned when created. This identifier stays constant as the composition is changed over time.\" class=\"dict\" href=\"composition-definitions.html#Composition.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">\r\n Logical identifier of composition (version-independent)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"The composition editing time, when the composition was last logically changed by the author.\" class=\"dict\" href=\"composition-definitions.html#Composition.date\"><b>date</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Composition editing time<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.\" class=\"dict\" href=\"composition-definitions.html#Composition.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-doc-codes.html\">Kind of composition (LOINC if possible)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"A categorization for the type of the composition. This may be implied by or derived from the code specified in the Composition Type.\" class=\"dict\" href=\"composition-definitions.html#Composition.class\"><b>class</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-xds-typecodes.html\">Categorization of Composition<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></class>\r\n <<a title=\"Official human-readable label for the composition.\" class=\"dict\" href=\"composition-definitions.html#Composition.title\"><b>title</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Human Readable name/title<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document (this element modifies the meaning of other elements)\" class=\"dict\" href=\"composition-definitions.html#Composition.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"composition-status.html\">preliminary | final | appended | amended | entered in error<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The code specifying the level of confidentiality of the Composition (this element modifies the meaning of other elements)\" class=\"dict\" href=\"composition-definitions.html#Composition.confidentiality\"><span style=\"text-decoration: underline\"><b>confidentiality</b></span></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Coding\">Coding</a></span> <a style=\"color: navy\" href=\"v3/vs/Confidentiality/index.html\">As defined by affinity domain<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a><span style=\"color: Gray\"> --></span></confidentiality>\r\n <<a title=\"Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (I.e. machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).\" class=\"dict\" href=\"composition-definitions.html#Composition.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"group.html#Group\">Group</a>|<a href=\"device.html#Device\">Device</a>|<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">\r\n Who and/or what the composition is about<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"Identifies who is responsible for the information in the composition. (Not necessarily who typed it in.).\" class=\"dict\" href=\"composition-definitions.html#Composition.author\"><b>author</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"device.html#Device\">Device</a>|<a href=\"patient.html#Patient\">Patient</a>|<a href=\"relatedperson.html#RelatedPerson\">RelatedPerson</a>)</span> <span style=\"color: navy\">\r\n Who and/or what authored the composition<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></author>\r\n <<a title=\"A participant who has attested to the accuracy of the composition/document.\" class=\"dict\" href=\"composition-definitions.html#Composition.attester\"><b>attester</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Attests to accuracy of composition<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span> --></span>\r\n <<a title=\"The type of attestation the authenticator offers.\" class=\"dict\" href=\"composition-definitions.html#Composition.attester.mode\"><b>mode</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..*</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"composition-attestation-mode.html\">personal | professional | legal | official<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"When composition was attested by the party.\" class=\"dict\" href=\"composition-definitions.html#Composition.attester.time\"><b>time</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When composition attested<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Who attested the composition in the specified way.\" class=\"dict\" href=\"composition-definitions.html#Composition.attester.party\"><b>party</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">Who attested the composition<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></party>\r\n </attester>\r\n <<a title=\"Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.\" class=\"dict\" href=\"composition-definitions.html#Composition.custodian\"><b>custodian</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">Org which maintains the composition<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></custodian>\r\n <<a title=\"The main event/act/item, such as a colonoscopy or an appendectomy, being documented.\" class=\"dict\" href=\"composition-definitions.html#Composition.event\"><b>event</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> The clinical event/act/item being documented<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span> --></span>\r\n <<a title=\"This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.\" class=\"dict\" href=\"composition-definitions.html#Composition.event.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v3/ActCode/index.html\">Code(s) that apply to the event being documented<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.\" class=\"dict\" href=\"composition-definitions.html#Composition.event.period\"><b>period</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">The period covered by the documentation<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></period>\r\n <<a title=\"Full details for the event(s) the composition/documentation consents.\" class=\"dict\" href=\"composition-definitions.html#Composition.event.detail\"><b>detail</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">Full details for the event(s) the composition consents<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></detail>\r\n </event>\r\n <<a title=\"Describes the clinical encounter or type of care this documentation is associated with.\" class=\"dict\" href=\"composition-definitions.html#Composition.encounter\"><b>encounter</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"encounter.html#Encounter\">Encounter</a>)</span> <span style=\"color: navy\">Context of the conposition<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></encounter>\r\n <<a title=\"The root of the sections that make up the composition.\" class=\"dict\" href=\"composition-definitions.html#Composition.section\"><b>section</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Composition is broken into sections --></span>\r\n <<a title=\"The heading for this particular section. This will be part of the rendered content for the document.\" class=\"dict\" href=\"composition-definitions.html#Composition.section.title\"><b>title</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Label for section</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A code identifying the kind of content contained within the section.\" class=\"dict\" href=\"composition-definitions.html#Composition.section.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-doc-section-codes.html\">Classification of section (recommended)</a></span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"Identifies the primary subject of the section (this element modifies the meaning of other elements)\" class=\"dict\" href=\"composition-definitions.html#Composition.section.subject\"><span style=\"text-decoration: underline\"><b>subject</b></span></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"group.html#Group\">Group</a>|<a href=\"device.html#Device\">Device</a>)</span> <span style=\"color: navy\">If section different to composition</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"Identifies the discrete data that provides the content for the section.\" class=\"dict\" href=\"composition-definitions.html#Composition.section.content\"><b>content</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: A section SHALL have content or one or more sections, but not both.\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">The actual data for the section</span><span style=\"color: Gray\"> --></span></content>\r\n <<a title=\"A nested sub-section within this section.\" class=\"dict\" href=\"composition-definitions.html#Composition.section.section\"><b>section</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: A section SHALL have content or one or more sections, but not both.\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> <span style=\"color: darkgreen\">Content as for Composition.section</span> <span style=\"color: navy\">Nested Section</span><span style=\"color: Gray\"> --></span></section>\r\n </section>\r\n</Composition>\r\n</pre></div>"
},
{
"title": "\"conceptmap\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/conceptmap",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/conceptmap.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"A statement of relationships from one set of concepts to one or more other concept systems.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap\"><b>ConceptMap</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"The identifier that is used to identify this concept map when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI).\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.identifier\"><b>identifier</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Logical id to reference this concept map<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The identifier that is used to identify this version of the concept map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.version\"><b>version</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Logical id for this version of the concept map<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A free text natural language name describing the concept map.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Informal name for this concept map<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The name of the individual or organization that published the concept map.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.publisher\"><b>publisher</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Name of the publisher (Organization or individual)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Contacts of the publisher to assist a user in finding and communicating with the publisher.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.telecom\"><b>telecom</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">Contact information of the publisher<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></telecom>\r\n <<a title=\"A free text natural language description of the use of the concept map - reason for definition, conditions of use, etc.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Human language description of the concept map<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A copyright statement relating to the concept map and/or its contents.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.copyright\"><b>copyright</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">About the concept map or its content</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The status of the concept map (this element modifies the meaning of other elements)\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-status.html\">draft | active | retired<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"This ConceptMap was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.experimental\"><b>experimental</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">If for testing purposes, not real usage<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The date that the concept map status was last changed.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.date\"><b>date</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Date for given status<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The source value set that specifies the concepts that are being mapped.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.source\"><b>source</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"valueset.html#ValueSet\">ValueSet</a>)</span> <span style=\"color: navy\">Identifies the source value set which is being mapped<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></source>\r\n <<a title=\"The target value set provides context to the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.target\"><b>target</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"valueset.html#ValueSet\">ValueSet</a>)</span> <span style=\"color: navy\">Provides context to the mappings<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></target>\r\n <<a title=\"Mappings for a concept from the source valueset.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept\"><b>concept</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Mappings for a concept from the source valueset --></span>\r\n <<a title=\"System that defines the concept being mapped.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.system\"><b>system</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">System that defines the concept being mapped</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identifies concept being mapped.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.code\"><b>code</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Identifies concept being mapped</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified concept can be resolved, and it has the specified value.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.dependsOn\"><b>dependsOn</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Other concepts required for this mapping (from context) --></span>\r\n <<a title=\"A reference to a specific concept that holds a coded value. This can be an element in a FHIR resource, or a specific reference to a data element in a different specification (e.g. v2) or a general reference to a kind of data field, or a reference to a value set with an appropriately narrow definition.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.dependsOn.concept\"><b>concept</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Reference to element/field/valueset provides the context</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"System for a concept in the referenced concept.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.dependsOn.system\"><b>system</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">System for a concept in the referenced concept</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Code for a concept in the referenced concept.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.dependsOn.code\"><b>code</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Code for a concept in the referenced concept</span><span style=\"color: Gray\"> --></span>\r\n </dependsOn>\r\n <<a title=\"A concept from the target value set that this concept maps to.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.map\"><b>map</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> A concept from the target value set that this concept maps to --></span>\r\n <<a title=\"System of the target.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.map.system\"><b>system</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: If a code is provided, a system SHALL be provided\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">System of the target</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Code that identifies the target concept.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.map.code\"><b>code</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Code that identifies the target concept</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"equal | equivalent | wider | subsumes | narrower | specialises | inexact | unmatched | disjoint (this element modifies the meaning of other elements)\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.map.equivalence\"><span style=\"text-decoration: underline\"><b>equivalence</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"concept-equivalence.html\">equal | equivalent | wider | subsumes | narrower | specialises | inexact | unmatched | disjoint</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Description of status/issues in mapping.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.map.comments\"><b>comments</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: If the map is narrower, there SHALL be some comments\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Description of status/issues in mapping</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A set of additional outcomes from this mapping to other value sets. To properly execute this mapping, the specified value set must be mapped to some data element or source that is in context. The mapping may still be useful without a place for the additional data elements, but the equivalence cannot be relied on.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.map.product\"><b>product</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\">Content as for ConceptMap.concept.dependsOn</span> <span style=\"color: navy\">Other concepts that this mapping also produces</span><span style=\"color: Gray\"> --></span></product>\r\n </map>\r\n </concept>\r\n</ConceptMap>\r\n</pre></div>"
},
"name": "conceptmap",
"publisher": "FHIR Project",
"description": "Basic Profile. A statement of relationships from one set of concepts to one or more other concept systems.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage A concept map defines a mapping from a concept defined in one system to one or more concepts defined in other systems. Mappings are always framed within the concept of value sets - they are specific to a context of use.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"structure": [
{
"type": "ConceptMap",
"publish": true,
"element": [
{
"path": "ConceptMap",
"definition": {
"short": "A statement of relationships from one set of concepts to one or more other concept systems",
"formal": "A statement of relationships from one set of concepts to one or more other concept systems.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ConceptMap.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.identifier",
"definition": {
"short": "Logical id to reference this concept map",
"formal": "The identifier that is used to identify this concept map when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI).",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ConceptMap.version",
"definition": {
"short": "Logical id for this version of the concept map",
"formal": "The identifier that is used to identify this version of the concept map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.",
"comments": "There may be multiple resource versions of the concept map that have this same identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ConceptMap.name",
"definition": {
"short": "Informal name for this concept map",
"formal": "A free text natural language name describing the concept map.",
"comments": "Not expected to be unique.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ConceptMap.publisher",
"definition": {
"short": "Name of the publisher (Organization or individual)",
"formal": "The name of the individual or organization that published the concept map.",
"comments": "Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.telecom",
"definition": {
"short": "Contact information of the publisher",
"formal": "Contacts of the publisher to assist a user in finding and communicating with the publisher.",
"comments": "May be a web site, an email address, a telephone number (tel:), etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "Contact"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.description",
"definition": {
"short": "Human language description of the concept map",
"formal": "A free text natural language description of the use of the concept map - reason for definition, conditions of use, etc.",
"comments": "The description is not intended to describe the semantics of the concept map. The description should capture its intended use, which is needed for ensuring integrity for its use in models across future changes.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ConceptMap.copyright",
"definition": {
"short": "About the concept map or its content",
"formal": "A copyright statement relating to the concept map and/or its contents.",
"comments": "Frequently, the copyright differs between the concept map, and codes that are included. The copyright statement should clearly differentiate between these when required.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.status",
"definition": {
"short": "draft | active | retired",
"formal": "The status of the concept map.",
"comments": "Allows filtering of ConceptMaps that are appropriate for use.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "ValueSetStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/valueset-status"
}
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ConceptMap.experimental",
"definition": {
"short": "If for testing purposes, not real usage",
"formal": "This ConceptMap was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"comments": "Allows filtering of ConceptMaps that are appropriate for use.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.date",
"definition": {
"short": "Date for given status",
"formal": "The date that the concept map status was last changed.",
"comments": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the concept map.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ConceptMap.source",
"definition": {
"short": "Identifies the source value set which is being mapped",
"formal": "The source value set that specifies the concepts that are being mapped.",
"comments": "Should be a version specific reference.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/ValueSet"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.target",
"definition": {
"short": "Provides context to the mappings",
"formal": "The target value set provides context to the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/ValueSet"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.concept",
"definition": {
"short": "Mappings for a concept from the source valueset",
"formal": "Mappings for a concept from the source valueset.",
"comments": "Generally, the ideal is that there would only be one mapping for each concept in the source value set, but a given concept may be mapped mutliple times with different comments or dependencies.",
"min": 0,
"max": "*",
"isModifier": false
}
},
{
"path": "ConceptMap.concept.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.concept.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.concept.system",
"definition": {
"short": "System that defines the concept being mapped",
"formal": "System that defines the concept being mapped.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.concept.code",
"definition": {
"short": "Identifies concept being mapped",
"formal": "Identifies concept being mapped.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.concept.dependsOn",
"definition": {
"short": "Other concepts required for this mapping (from context)",
"formal": "A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified concept can be resolved, and it has the specified value.",
"min": 0,
"max": "*",
"isModifier": false
}
},
{
"path": "ConceptMap.concept.dependsOn.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.concept.dependsOn.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.concept.dependsOn.concept",
"definition": {
"short": "Reference to element/field/valueset provides the context",
"formal": "A reference to a specific concept that holds a coded value. This can be an element in a FHIR resource, or a specific reference to a data element in a different specification (e.g. v2) or a general reference to a kind of data field, or a reference to a value set with an appropriately narrow definition.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.concept.dependsOn.system",
"definition": {
"short": "System for a concept in the referenced concept",
"formal": "System for a concept in the referenced concept.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.concept.dependsOn.code",
"definition": {
"short": "Code for a concept in the referenced concept",
"formal": "Code for a concept in the referenced concept.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.concept.map",
"definition": {
"short": "A concept from the target value set that this concept maps to",
"formal": "A concept from the target value set that this concept maps to.",
"comments": "Ideally there would only be one map, with equal or equivalent mapping. But multiple maps are allowed for several narrower options, or to assert that other concepts are unmatched.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "2",
"severity": "error",
"human": "If a code is provided, a system SHALL be provided",
"xpath": "exists(f:system) or not(exists(f:code))"
},
{
"key": "1",
"severity": "error",
"human": "If the map is narrower, there SHALL be some comments",
"xpath": "exists(f:comments) or ((f:equivalence/@value != 'narrower') and (f:equivalence/@value != 'inexact'))"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.concept.map.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.concept.map.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.concept.map.system",
"definition": {
"short": "System of the target",
"formal": "System of the target.",
"comments": "Should be a version specific reference.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.concept.map.code",
"definition": {
"short": "Code that identifies the target concept",
"formal": "Code that identifies the target concept.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.concept.map.equivalence",
"definition": {
"short": "equal | equivalent | wider | subsumes | narrower | specialises | inexact | unmatched | disjoint",
"formal": "equal | equivalent | wider | subsumes | narrower | specialises | inexact | unmatched | disjoint.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "ConceptMapEquivalence",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/concept-equivalence"
}
}
}
},
{
"path": "ConceptMap.concept.map.comments",
"definition": {
"short": "Description of status/issues in mapping",
"formal": "Description of status/issues in mapping.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.concept.map.product",
"definition": {
"short": "Other concepts that this mapping also produces",
"formal": "A set of additional outcomes from this mapping to other value sets. To properly execute this mapping, the specified value set must be mapped to some data element or source that is in context. The mapping may still be useful without a place for the additional data elements, but the equivalence cannot be relied on.",
"min": 0,
"max": "*",
"nameReference": "ConceptMap.concept.dependsOn",
"isModifier": false
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "date",
"type": "date",
"documentation": "The concept map publication date",
"xpath": "f:ConceptMap/f:date"
},
{
"name": "dependson",
"type": "token",
"documentation": "Reference to element/field/valueset provides the context",
"xpath": "f:ConceptMap/f:concept/f:dependsOn/f:concept"
},
{
"name": "description",
"type": "string",
"documentation": "Text search in the description of the concept map",
"xpath": "f:ConceptMap/f:description"
},
{
"name": "identifier",
"type": "token",
"documentation": "The identifier of the concept map",
"xpath": "f:ConceptMap/f:identifier"
},
{
"name": "name",
"type": "string",
"documentation": "Name of the concept map",
"xpath": "f:ConceptMap/f:name"
},
{
"name": "product",
"type": "token",
"documentation": "Reference to element/field/valueset provides the context",
"xpath": "f:ConceptMap/f:concept/f:map/f:product/f:concept"
},
{
"name": "publisher",
"type": "string",
"documentation": "Name of the publisher of the concept map",
"xpath": "f:ConceptMap/f:publisher"
},
{
"name": "source",
"type": "reference",
"documentation": "The system for any concepts mapped by this concept map",
"xpath": "f:ConceptMap/f:source"
},
{
"name": "status",
"type": "token",
"documentation": "Status of the concept map",
"xpath": "f:ConceptMap/f:status"
},
{
"name": "system",
"type": "token",
"documentation": "The system for any destination concepts mapped by this map",
"xpath": "f:ConceptMap/f:concept/f:map/f:system"
},
{
"name": "target",
"type": "reference",
"documentation": "Provides context to the mappings",
"xpath": "f:ConceptMap/f:target"
},
{
"name": "version",
"type": "token",
"documentation": "The version identifier of the concept map",
"xpath": "f:ConceptMap/f:version"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"A statement of relationships from one set of concepts to one or more other concept systems.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap\"><b>ConceptMap</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"The identifier that is used to identify this concept map when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI).\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.identifier\"><b>identifier</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Logical id to reference this concept map<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The identifier that is used to identify this version of the concept map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.version\"><b>version</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Logical id for this version of the concept map<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A free text natural language name describing the concept map.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Informal name for this concept map<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The name of the individual or organization that published the concept map.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.publisher\"><b>publisher</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Name of the publisher (Organization or individual)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Contacts of the publisher to assist a user in finding and communicating with the publisher.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.telecom\"><b>telecom</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">Contact information of the publisher<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></telecom>\r\n <<a title=\"A free text natural language description of the use of the concept map - reason for definition, conditions of use, etc.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Human language description of the concept map<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A copyright statement relating to the concept map and/or its contents.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.copyright\"><b>copyright</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">About the concept map or its content</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The status of the concept map (this element modifies the meaning of other elements)\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-status.html\">draft | active | retired<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"This ConceptMap was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.experimental\"><b>experimental</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">If for testing purposes, not real usage<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The date that the concept map status was last changed.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.date\"><b>date</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Date for given status<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The source value set that specifies the concepts that are being mapped.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.source\"><b>source</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"valueset.html#ValueSet\">ValueSet</a>)</span> <span style=\"color: navy\">Identifies the source value set which is being mapped<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></source>\r\n <<a title=\"The target value set provides context to the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.target\"><b>target</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"valueset.html#ValueSet\">ValueSet</a>)</span> <span style=\"color: navy\">Provides context to the mappings<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></target>\r\n <<a title=\"Mappings for a concept from the source valueset.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept\"><b>concept</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Mappings for a concept from the source valueset --></span>\r\n <<a title=\"System that defines the concept being mapped.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.system\"><b>system</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">System that defines the concept being mapped</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identifies concept being mapped.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.code\"><b>code</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Identifies concept being mapped</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified concept can be resolved, and it has the specified value.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.dependsOn\"><b>dependsOn</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Other concepts required for this mapping (from context) --></span>\r\n <<a title=\"A reference to a specific concept that holds a coded value. This can be an element in a FHIR resource, or a specific reference to a data element in a different specification (e.g. v2) or a general reference to a kind of data field, or a reference to a value set with an appropriately narrow definition.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.dependsOn.concept\"><b>concept</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Reference to element/field/valueset provides the context</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"System for a concept in the referenced concept.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.dependsOn.system\"><b>system</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">System for a concept in the referenced concept</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Code for a concept in the referenced concept.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.dependsOn.code\"><b>code</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Code for a concept in the referenced concept</span><span style=\"color: Gray\"> --></span>\r\n </dependsOn>\r\n <<a title=\"A concept from the target value set that this concept maps to.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.map\"><b>map</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> A concept from the target value set that this concept maps to --></span>\r\n <<a title=\"System of the target.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.map.system\"><b>system</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: If a code is provided, a system SHALL be provided\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">System of the target</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Code that identifies the target concept.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.map.code\"><b>code</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Code that identifies the target concept</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"equal | equivalent | wider | subsumes | narrower | specialises | inexact | unmatched | disjoint (this element modifies the meaning of other elements)\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.map.equivalence\"><span style=\"text-decoration: underline\"><b>equivalence</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"concept-equivalence.html\">equal | equivalent | wider | subsumes | narrower | specialises | inexact | unmatched | disjoint</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Description of status/issues in mapping.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.map.comments\"><b>comments</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: If the map is narrower, there SHALL be some comments\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Description of status/issues in mapping</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A set of additional outcomes from this mapping to other value sets. To properly execute this mapping, the specified value set must be mapped to some data element or source that is in context. The mapping may still be useful without a place for the additional data elements, but the equivalence cannot be relied on.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.map.product\"><b>product</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\">Content as for ConceptMap.concept.dependsOn</span> <span style=\"color: navy\">Other concepts that this mapping also produces</span><span style=\"color: Gray\"> --></span></product>\r\n </map>\r\n </concept>\r\n</ConceptMap>\r\n</pre></div>"
},
{
"title": "\"condition\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/condition",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/condition.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"Use to record detailed information about conditions, problems or diagnoses recognized by a clinician. There are many uses including: recording a Diagnosis during an Encounter; populating a problem List or a Summary Statement, such as a Discharge Summary.\" class=\"dict\" href=\"condition-definitions.html#Condition\"><b>Condition</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"This records identifiers associated with this condition that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).\" class=\"dict\" href=\"condition-definitions.html#Condition.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">External Ids for this condition</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Indicates the patient who the condition record is associated with.\" class=\"dict\" href=\"condition-definitions.html#Condition.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Who has the condition?</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"Encounter during which the condition was first asserted.\" class=\"dict\" href=\"condition-definitions.html#Condition.encounter\"><b>encounter</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"encounter.html#Encounter\">Encounter</a>)</span> <span style=\"color: navy\">Encounter when condition first asserted</span><span style=\"color: Gray\"> --></span></encounter>\r\n <<a title=\"Person who takes responsibility for asserting the existence of the condition as part of the electronic record.\" class=\"dict\" href=\"condition-definitions.html#Condition.asserter\"><b>asserter</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Person who asserts this condition</span><span style=\"color: Gray\"> --></span></asserter>\r\n <<a title=\"Estimated or actual date the condition/problem/diagnosis was first detected/suspected.\" class=\"dict\" href=\"condition-definitions.html#Condition.dateAsserted\"><b>dateAsserted</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#date\">date</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When first detected/suspected/entered</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identification of the condition, problem or diagnosis.\" class=\"dict\" href=\"condition-definitions.html#Condition.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-condition-code.html\">Identification of the condition, problem or diagnosis</a></span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"A category assigned to the condition. E.g. complaint | symptom | finding | diagnosis.\" class=\"dict\" href=\"condition-definitions.html#Condition.category\"><b>category</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-condition-category.html\">E.g. complaint | symptom | finding | diagnosis</a></span><span style=\"color: Gray\"> --></span></category>\r\n <<a title=\"The clinical status of the condition (this element modifies the meaning of other elements)\" class=\"dict\" href=\"condition-definitions.html#Condition.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"condition-status.html\">provisional | working | confirmed | refuted</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The degree of confidence that this condition is correct (this element modifies the meaning of other elements)\" class=\"dict\" href=\"condition-definitions.html#Condition.certainty\"><span style=\"text-decoration: underline\"><b>certainty</b></span></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-condition-certainty.html\">Degree of confidence</a></span><span style=\"color: Gray\"> --></span></certainty>\r\n <<a title=\"A subjective assessment of the severity of the condition as evaluated by the clinician.\" class=\"dict\" href=\"condition-definitions.html#Condition.severity\"><b>severity</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-condition-severity.html\">Subjective severity of condition</a></span><span style=\"color: Gray\"> --></span></severity>\r\n <<a title=\"Estimated or actual date the condition began, in the opinion of the clinician.\" class=\"dict\" href=\"condition-definitions.html#Condition.onset_x_\"><b>onset[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#date\">date</a>|<a href=\"datatypes.html#Age\">Age</a></span> <span style=\"color: navy\">Estimated or actual date, or age</span><span style=\"color: Gray\"> --></span></onset[x]>\r\n <<a title=\"The date or estimated date that the condition resolved or went into remission. This is called "abatement" because of the many overloaded connotations associated with "remission" or "resolution" - Conditions are never really resolved, but they can abate.\" class=\"dict\" href=\"condition-definitions.html#Condition.abatement_x_\"><b>abatement[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#date\">date</a>|<a href=\"datatypes.html#Age\">Age</a>|<a href=\"datatypes.html#boolean\">boolean</a></span> <span style=\"color: navy\">If/when in resolution/remission</span><span style=\"color: Gray\"> --></span></abatement[x]>\r\n <<a title=\"Clinical stage or grade of a condition. May include formal severity assessments.\" class=\"dict\" href=\"condition-definitions.html#Condition.stage\"><b>stage</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> Stage/grade, usually assessed formally --></span>\r\n <<a title=\"A simple summary of the stage such as "Stage 3". The determination of the stage is disease-specific.\" class=\"dict\" href=\"condition-definitions.html#Condition.stage.summary\"><b>summary</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: Stage SHALL have summary or assessment\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Simple summary (disease specific)</span><span style=\"color: Gray\"> --></span></summary>\r\n <<a title=\"Reference to a formal record of the evidence on which the staging assessment is based.\" class=\"dict\" href=\"condition-definitions.html#Condition.stage.assessment\"><b>assessment</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: Stage SHALL have summary or assessment\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">Formal record of assessment</span><span style=\"color: Gray\"> --></span></assessment>\r\n </stage>\r\n <<a title=\"Supporting Evidence / manifestations that are the basis on which this condition is suspected or confirmed.\" class=\"dict\" href=\"condition-definitions.html#Condition.evidence\"><b>evidence</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Supporting evidence --></span>\r\n <<a title=\"A manifestation or symptom that led to the recording of this condition.\" class=\"dict\" href=\"condition-definitions.html#Condition.evidence.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: evidence SHALL have code or details\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Manifestation/symptom</span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"Links to other relevant information, including pathology reports.\" class=\"dict\" href=\"condition-definitions.html#Condition.evidence.detail\"><b>detail</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: evidence SHALL have code or details\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">Supporting information found elsewhere</span><span style=\"color: Gray\"> --></span></detail>\r\n </evidence>\r\n <<a title=\"The anatomical location where this condition manifests itself.\" class=\"dict\" href=\"condition-definitions.html#Condition.location\"><b>location</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Anatomical location, if relevant --></span>\r\n <<a title=\"Code that identifies the structural location.\" class=\"dict\" href=\"condition-definitions.html#Condition.location.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-3: location SHALL have code or details\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Location - may include laterality</span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"Detailed anatomical location information.\" class=\"dict\" href=\"condition-definitions.html#Condition.location.detail\"><b>detail</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-3: location SHALL have code or details\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Precise location details</span><span style=\"color: Gray\"> --></span>\r\n </location>\r\n <<a title=\"Further conditions, problems, diagnoses, procedures or events that are related in some way to this condition, or the substance that caused/triggered this Condition.\" class=\"dict\" href=\"condition-definitions.html#Condition.relatedItem\"><b>relatedItem</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Causes or precedents for this Condition --></span>\r\n <<a title=\"The type of relationship that this condition has to the related item.\" class=\"dict\" href=\"condition-definitions.html#Condition.relatedItem.type\"><b>type</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"condition-relationship-type.html\">due-to | following</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Code that identifies the target of this relationship. The code takes the place of a detailed instance target.\" class=\"dict\" href=\"condition-definitions.html#Condition.relatedItem.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-4: Relationship SHALL have either a code or a target\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-condition-code.html\">Relationship target by means of a predefined code</a></span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"Target of the relationship.\" class=\"dict\" href=\"condition-definitions.html#Condition.relatedItem.target\"><b>target</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-4: Relationship SHALL have either a code or a target\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"condition.html#Condition\">Condition</a>|<a href=\"procedure.html#Procedure\">Procedure</a>|<a href=\"medicationadministration.html#MedicationAdministration\">MedicationAdministration</a>|\r\n <a href=\"immunization.html#Immunization\">Immunization</a>|<a href=\"medicationstatement.html#MedicationStatement\">MedicationStatement</a>)</span> <span style=\"color: navy\">Relationship target resource</span><span style=\"color: Gray\"> --></span></target>\r\n </relatedItem>\r\n <<a title=\"Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis.\" class=\"dict\" href=\"condition-definitions.html#Condition.notes\"><b>notes</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Additional information about the Condition</span><span style=\"color: Gray\"> --></span>\r\n</Condition>\r\n</pre></div>"
},
"name": "condition",
"publisher": "FHIR Project",
"description": "Basic Profile. Use to record detailed information about conditions, problems or diagnoses recognized by a clinician. There are many uses including: recording a Diagnosis during an Encounter; populating a problem List or a Summary Statement, such as a Discharge Summary.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage This resource is used to record detailed information about a specific aspect of or issue with the health state of a patient. It is intended for use for issues that have been identified as relevant for tracking and reporting purposes or where there's a need to capture a concrete diagnosis or the gathering of data such as signs and symptoms. There are situations where the same information might appear as both an observation as well as a condition. For example, the appearance of a rash or an instance of a fever are signs and symptoms that would typically be captured using the Observation resource. However, a pattern of ongoing fevers or a persistent or severe rash requiring treatment might be captured as a condition. The Condition resource specifically excludes AdverseReactions and AllergyIntolerances as those are handled with their own resources. \r\n\r\nThe Condition resource may be used to record positive aspects of the health state of a patient (e.g. pregnancy) as well as the major use, which is for problems/concerns (e.g. hypertension). \r\n\r\nConditions are frequently referenced by other resources as \"reasons\" for an action (Prescription, Procedure, DiagnosticOrder, etc.) \r\n\r\nThe conditions represented in this resources are sometimes described as \"Problems\", and kept as part of a problem list.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "Condition",
"publish": true,
"element": [
{
"path": "Condition",
"definition": {
"short": "Detailed information about conditions, problems or diagnoses",
"formal": "Use to record detailed information about conditions, problems or diagnoses recognized by a clinician. There are many uses including: recording a Diagnosis during an Encounter; populating a problem List or a Summary Statement, such as a Discharge Summary.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Observation[classCode=OBS, moodCode=EVN, code=ASSERTION, value<Diagnosis]"
},
{
"identity": "v2",
"map": "PPR message"
}
]
}
},
{
"path": "Condition.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Condition.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Condition.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "Condition.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "Condition.identifier",
"definition": {
"short": "External Ids for this condition",
"formal": "This records identifiers associated with this condition that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
}
},
{
"path": "Condition.subject",
"definition": {
"short": "Who has the condition?",
"formal": "Indicates the patient who the condition record is associated with.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=PAT]"
},
{
"identity": "v2",
"map": "PID-3"
}
]
}
},
{
"path": "Condition.encounter",
"definition": {
"short": "Encounter when condition first asserted",
"formal": "Encounter during which the condition was first asserted.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Encounter"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"
},
{
"identity": "v2",
"map": "PV1-19 (+PV1-54)"
}
]
}
},
{
"path": "Condition.asserter",
"definition": {
"short": "Person who asserts this condition",
"formal": "Person who takes responsibility for asserting the existence of the condition as part of the electronic record.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
},
{
"identity": "v2",
"map": "REL-7.1 identifier + REL-7.12 type code"
}
]
}
},
{
"path": "Condition.dateAsserted",
"definition": {
"short": "When first detected/suspected/entered",
"formal": "Estimated or actual date the condition/problem/diagnosis was first detected/suspected.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
},
{
"identity": "v2",
"map": "REL-11"
}
]
}
},
{
"path": "Condition.code",
"definition": {
"short": "Identification of the condition, problem or diagnosis",
"formal": "Identification of the condition, problem or diagnosis.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ConditionKind",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/condition-code"
}
},
"mapping": [
{
"identity": "rim",
"map": ".value"
},
{
"identity": "v2",
"map": "PRB-3"
}
]
}
},
{
"path": "Condition.category",
"definition": {
"short": "E.g. complaint | symptom | finding | diagnosis",
"formal": "A category assigned to the condition. E.g. complaint | symptom | finding | diagnosis.",
"comments": "The categorization is often highly contextual and may appear poorly differentiated or not very useful in other contexts.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ConditionCategory",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/condition-category"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "v2",
"map": "'problem' if from PRB-3. 'diagnosis' if from DG1 segment in PV1 message"
}
]
}
},
{
"path": "Condition.status",
"definition": {
"short": "provisional | working | confirmed | refuted",
"formal": "The clinical status of the condition.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "ConditionStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/condition-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code (pre or post-coordinated in)\n\nCan use valueNegationInd for refuted"
},
{
"identity": "v2",
"map": "PRB-14 / DG1-6"
}
]
}
},
{
"path": "Condition.certainty",
"definition": {
"short": "Degree of confidence",
"formal": "The degree of confidence that this condition is correct.",
"comments": "May be a percentage.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": true,
"binding": {
"name": "ConditionCertainty",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/condition-certainty"
}
},
"mapping": [
{
"identity": "rim",
"map": ".uncertaintyCode"
},
{
"identity": "v2",
"map": "PRB-19"
}
]
}
},
{
"path": "Condition.severity",
"definition": {
"short": "Subjective severity of condition",
"formal": "A subjective assessment of the severity of the condition as evaluated by the clinician.",
"comments": "Coding of the severity with a terminology is preferred, where possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ConditionSeverity",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/condition-severity"
}
},
"mapping": [
{
"identity": "rim",
"map": "Can be pre/post-coordinated into value. Or\n./inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"severity\"].value"
},
{
"identity": "v2",
"map": "PRB-26 / ABS-3"
}
]
}
},
{
"path": "Condition.onset[x]",
"definition": {
"short": "Estimated or actual date, or age",
"formal": "Estimated or actual date the condition began, in the opinion of the clinician.",
"comments": "Age is generally used when the patient reports an age at which the Condition began to occur.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
},
{
"code": "Age"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime.low\nor\n.inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"age at onset\"].value"
},
{
"identity": "v2",
"map": "PRB-16"
}
]
}
},
{
"path": "Condition.abatement[x]",
"definition": {
"short": "If/when in resolution/remission",
"formal": "The date or estimated date that the condition resolved or went into remission. This is called \"abatement\" because of the many overloaded connotations associated with \"remission\" or \"resolution\" - Conditions are never really resolved, but they can abate.",
"comments": "There is no explicit distinction between resolution and remission because in many cases the distinction is not clear. Age is generally used when the patient reports an age at which the Condition abated.\n\nIf there is no abatement element, it is unknown whether the condition has resolved or entered remission; applications and users should generally assume that the condition is still valid.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
},
{
"code": "Age"
},
{
"code": "boolean"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime.high\nor\n.inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"age at remission\"].value\nor\n.inboundRelationship[typeCode=SUBJ]source[classCode=CONC, moodCode=EVN].status=completed"
}
]
}
},
{
"path": "Condition.stage",
"definition": {
"short": "Stage/grade, usually assessed formally",
"formal": "Clinical stage or grade of a condition. May include formal severity assessments.",
"min": 0,
"max": "1",
"constraint": [
{
"key": "1",
"name": "Stage rule",
"severity": "error",
"human": "Stage SHALL have summary or assessment",
"xpath": "exists(f:summary) or exists(f:assessment)"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"stage/grade\"]"
}
]
}
},
{
"path": "Condition.stage.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Condition.stage.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Condition.stage.summary",
"definition": {
"short": "Simple summary (disease specific)",
"formal": "A simple summary of the stage such as \"Stage 3\". The determination of the stage is disease-specific.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".value"
}
]
}
},
{
"path": "Condition.stage.assessment",
"definition": {
"short": "Formal record of assessment",
"formal": "Reference to a formal record of the evidence on which the staging assessment is based.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Any"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".self"
}
]
}
},
{
"path": "Condition.evidence",
"definition": {
"short": "Supporting evidence",
"formal": "Supporting Evidence / manifestations that are the basis on which this condition is suspected or confirmed.",
"comments": "The evidence may be a simple list of coded symptoms/manifestations, or references to observations or formal assessments, or both.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "2",
"name": "Evidence",
"severity": "error",
"human": "evidence SHALL have code or details",
"xpath": "exists(f:code) or exists(f:detail)"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=SPRT].target[classCode=OBS, moodCode=EVN]"
}
]
}
},
{
"path": "Condition.evidence.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Condition.evidence.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Condition.evidence.code",
"definition": {
"short": "Manifestation/symptom",
"formal": "A manifestation or symptom that led to the recording of this condition.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "[code=\"diagnosis\"].value"
}
]
}
},
{
"path": "Condition.evidence.detail",
"definition": {
"short": "Supporting information found elsewhere",
"formal": "Links to other relevant information, including pathology reports.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Any"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".self"
}
]
}
},
{
"path": "Condition.location",
"definition": {
"short": "Anatomical location, if relevant",
"formal": "The anatomical location where this condition manifests itself.",
"comments": "May be a summary code, or a reference to a very precise definition of the location, or both.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "3",
"name": "Location",
"severity": "error",
"human": "location SHALL have code or details",
"xpath": "exists(f:code) or exists(f:detail)"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".targetBodySiteCode"
}
]
}
},
{
"path": "Condition.location.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Condition.location.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Condition.location.code",
"definition": {
"short": "Location - may include laterality",
"formal": "Code that identifies the structural location.",
"comments": "May include laterality.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".self"
}
]
}
},
{
"path": "Condition.location.detail",
"definition": {
"short": "Precise location details",
"formal": "Detailed anatomical location information.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".originalText"
}
]
}
},
{
"path": "Condition.relatedItem",
"definition": {
"short": "Causes or precedents for this Condition",
"formal": "Further conditions, problems, diagnoses, procedures or events that are related in some way to this condition, or the substance that caused/triggered this Condition.",
"comments": "Although a condition may be caused by a substance, this is not intended to be used to record allergies/adverse reactions to substances.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "4",
"name": "Relationship",
"severity": "error",
"human": "Relationship SHALL have either a code or a target",
"xpath": "exists(f:code) != exists(f:target)"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RSON, SAS]"
},
{
"identity": "v2",
"map": "could infer from presence of multiple PRB segments in a PPR message that the problems are related, but not clear how to communicate the nature of the relationship"
}
]
}
},
{
"path": "Condition.relatedItem.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Condition.relatedItem.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Condition.relatedItem.type",
"definition": {
"short": "due-to | following",
"formal": "The type of relationship that this condition has to the related item.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "ConditionRelationshipType",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/condition-relationship-type"
}
},
"mapping": [
{
"identity": "rim",
"map": ".typeCode"
}
]
}
},
{
"path": "Condition.relatedItem.code",
"definition": {
"short": "Relationship target by means of a predefined code",
"formal": "Code that identifies the target of this relationship. The code takes the place of a detailed instance target.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ConditionKind",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/condition-code"
}
},
"mapping": [
{
"identity": "rim",
"map": ".target[classCode=OBS, moodCode=EVN].code"
}
]
}
},
{
"path": "Condition.relatedItem.target",
"definition": {
"short": "Relationship target resource",
"formal": "Target of the relationship.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Condition"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Procedure"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/MedicationAdministration"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Immunization"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/MedicationStatement"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".target[classCode=OBS, moodCode=EVN]"
}
]
}
},
{
"path": "Condition.notes",
"definition": {
"short": "Additional information about the Condition",
"formal": "Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
},
{
"identity": "v2",
"map": "NTE child of PRB"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "asserter",
"type": "reference",
"documentation": "Person who asserts this condition",
"xpath": "f:Condition/f:asserter"
},
{
"name": "category",
"type": "token",
"documentation": "The category of the condition",
"xpath": "f:Condition/f:category"
},
{
"name": "code",
"type": "token",
"documentation": "Code for the condition",
"xpath": "f:Condition/f:code"
},
{
"name": "date-asserted",
"type": "date",
"documentation": "When first detected/suspected/entered",
"xpath": "f:Condition/f:dateAsserted"
},
{
"name": "encounter",
"type": "reference",
"documentation": "Encounter when condition first asserted",
"xpath": "f:Condition/f:encounter"
},
{
"name": "evidence",
"type": "token",
"documentation": "Manifestation/symptom",
"xpath": "f:Condition/f:evidence/f:code"
},
{
"name": "location",
"type": "token",
"documentation": "Location - may include laterality",
"xpath": "f:Condition/f:location/f:code"
},
{
"name": "onset",
"type": "date",
"documentation": "When the Condition started (if started on a date)",
"xpath": "f:Condition/f:onset[x]"
},
{
"name": "related-code",
"type": "token",
"documentation": "Relationship target by means of a predefined code",
"xpath": "f:Condition/f:relatedItem/f:code"
},
{
"name": "related-item",
"type": "reference",
"documentation": "Relationship target resource",
"xpath": "f:Condition/f:relatedItem/f:target"
},
{
"name": "severity",
"type": "token",
"documentation": "The severity of the condition",
"xpath": "f:Condition/f:severity"
},
{
"name": "stage",
"type": "token",
"documentation": "Simple summary (disease specific)",
"xpath": "f:Condition/f:stage/f:summary"
},
{
"name": "status",
"type": "token",
"documentation": "The status of the condition",
"xpath": "f:Condition/f:status"
},
{
"name": "subject",
"type": "reference",
"documentation": "Who has the condition?",
"xpath": "f:Condition/f:subject"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"Use to record detailed information about conditions, problems or diagnoses recognized by a clinician. There are many uses including: recording a Diagnosis during an Encounter; populating a problem List or a Summary Statement, such as a Discharge Summary.\" class=\"dict\" href=\"condition-definitions.html#Condition\"><b>Condition</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"This records identifiers associated with this condition that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).\" class=\"dict\" href=\"condition-definitions.html#Condition.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">External Ids for this condition</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Indicates the patient who the condition record is associated with.\" class=\"dict\" href=\"condition-definitions.html#Condition.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Who has the condition?</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"Encounter during which the condition was first asserted.\" class=\"dict\" href=\"condition-definitions.html#Condition.encounter\"><b>encounter</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"encounter.html#Encounter\">Encounter</a>)</span> <span style=\"color: navy\">Encounter when condition first asserted</span><span style=\"color: Gray\"> --></span></encounter>\r\n <<a title=\"Person who takes responsibility for asserting the existence of the condition as part of the electronic record.\" class=\"dict\" href=\"condition-definitions.html#Condition.asserter\"><b>asserter</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Person who asserts this condition</span><span style=\"color: Gray\"> --></span></asserter>\r\n <<a title=\"Estimated or actual date the condition/problem/diagnosis was first detected/suspected.\" class=\"dict\" href=\"condition-definitions.html#Condition.dateAsserted\"><b>dateAsserted</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#date\">date</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When first detected/suspected/entered</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identification of the condition, problem or diagnosis.\" class=\"dict\" href=\"condition-definitions.html#Condition.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-condition-code.html\">Identification of the condition, problem or diagnosis</a></span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"A category assigned to the condition. E.g. complaint | symptom | finding | diagnosis.\" class=\"dict\" href=\"condition-definitions.html#Condition.category\"><b>category</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-condition-category.html\">E.g. complaint | symptom | finding | diagnosis</a></span><span style=\"color: Gray\"> --></span></category>\r\n <<a title=\"The clinical status of the condition (this element modifies the meaning of other elements)\" class=\"dict\" href=\"condition-definitions.html#Condition.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"condition-status.html\">provisional | working | confirmed | refuted</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The degree of confidence that this condition is correct (this element modifies the meaning of other elements)\" class=\"dict\" href=\"condition-definitions.html#Condition.certainty\"><span style=\"text-decoration: underline\"><b>certainty</b></span></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-condition-certainty.html\">Degree of confidence</a></span><span style=\"color: Gray\"> --></span></certainty>\r\n <<a title=\"A subjective assessment of the severity of the condition as evaluated by the clinician.\" class=\"dict\" href=\"condition-definitions.html#Condition.severity\"><b>severity</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-condition-severity.html\">Subjective severity of condition</a></span><span style=\"color: Gray\"> --></span></severity>\r\n <<a title=\"Estimated or actual date the condition began, in the opinion of the clinician.\" class=\"dict\" href=\"condition-definitions.html#Condition.onset_x_\"><b>onset[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#date\">date</a>|<a href=\"datatypes.html#Age\">Age</a></span> <span style=\"color: navy\">Estimated or actual date, or age</span><span style=\"color: Gray\"> --></span></onset[x]>\r\n <<a title=\"The date or estimated date that the condition resolved or went into remission. This is called "abatement" because of the many overloaded connotations associated with "remission" or "resolution" - Conditions are never really resolved, but they can abate.\" class=\"dict\" href=\"condition-definitions.html#Condition.abatement_x_\"><b>abatement[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#date\">date</a>|<a href=\"datatypes.html#Age\">Age</a>|<a href=\"datatypes.html#boolean\">boolean</a></span> <span style=\"color: navy\">If/when in resolution/remission</span><span style=\"color: Gray\"> --></span></abatement[x]>\r\n <<a title=\"Clinical stage or grade of a condition. May include formal severity assessments.\" class=\"dict\" href=\"condition-definitions.html#Condition.stage\"><b>stage</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> Stage/grade, usually assessed formally --></span>\r\n <<a title=\"A simple summary of the stage such as "Stage 3". The determination of the stage is disease-specific.\" class=\"dict\" href=\"condition-definitions.html#Condition.stage.summary\"><b>summary</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: Stage SHALL have summary or assessment\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Simple summary (disease specific)</span><span style=\"color: Gray\"> --></span></summary>\r\n <<a title=\"Reference to a formal record of the evidence on which the staging assessment is based.\" class=\"dict\" href=\"condition-definitions.html#Condition.stage.assessment\"><b>assessment</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: Stage SHALL have summary or assessment\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">Formal record of assessment</span><span style=\"color: Gray\"> --></span></assessment>\r\n </stage>\r\n <<a title=\"Supporting Evidence / manifestations that are the basis on which this condition is suspected or confirmed.\" class=\"dict\" href=\"condition-definitions.html#Condition.evidence\"><b>evidence</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Supporting evidence --></span>\r\n <<a title=\"A manifestation or symptom that led to the recording of this condition.\" class=\"dict\" href=\"condition-definitions.html#Condition.evidence.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: evidence SHALL have code or details\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Manifestation/symptom</span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"Links to other relevant information, including pathology reports.\" class=\"dict\" href=\"condition-definitions.html#Condition.evidence.detail\"><b>detail</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: evidence SHALL have code or details\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">Supporting information found elsewhere</span><span style=\"color: Gray\"> --></span></detail>\r\n </evidence>\r\n <<a title=\"The anatomical location where this condition manifests itself.\" class=\"dict\" href=\"condition-definitions.html#Condition.location\"><b>location</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Anatomical location, if relevant --></span>\r\n <<a title=\"Code that identifies the structural location.\" class=\"dict\" href=\"condition-definitions.html#Condition.location.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-3: location SHALL have code or details\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Location - may include laterality</span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"Detailed anatomical location information.\" class=\"dict\" href=\"condition-definitions.html#Condition.location.detail\"><b>detail</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-3: location SHALL have code or details\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Precise location details</span><span style=\"color: Gray\"> --></span>\r\n </location>\r\n <<a title=\"Further conditions, problems, diagnoses, procedures or events that are related in some way to this condition, or the substance that caused/triggered this Condition.\" class=\"dict\" href=\"condition-definitions.html#Condition.relatedItem\"><b>relatedItem</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Causes or precedents for this Condition --></span>\r\n <<a title=\"The type of relationship that this condition has to the related item.\" class=\"dict\" href=\"condition-definitions.html#Condition.relatedItem.type\"><b>type</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"condition-relationship-type.html\">due-to | following</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Code that identifies the target of this relationship. The code takes the place of a detailed instance target.\" class=\"dict\" href=\"condition-definitions.html#Condition.relatedItem.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-4: Relationship SHALL have either a code or a target\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-condition-code.html\">Relationship target by means of a predefined code</a></span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"Target of the relationship.\" class=\"dict\" href=\"condition-definitions.html#Condition.relatedItem.target\"><b>target</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-4: Relationship SHALL have either a code or a target\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"condition.html#Condition\">Condition</a>|<a href=\"procedure.html#Procedure\">Procedure</a>|<a href=\"medicationadministration.html#MedicationAdministration\">MedicationAdministration</a>|\r\n <a href=\"immunization.html#Immunization\">Immunization</a>|<a href=\"medicationstatement.html#MedicationStatement\">MedicationStatement</a>)</span> <span style=\"color: navy\">Relationship target resource</span><span style=\"color: Gray\"> --></span></target>\r\n </relatedItem>\r\n <<a title=\"Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis.\" class=\"dict\" href=\"condition-definitions.html#Condition.notes\"><b>notes</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Additional information about the Condition</span><span style=\"color: Gray\"> --></span>\r\n</Condition>\r\n</pre></div>"
},
{
"title": "\"conformance\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/conformance",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/conformance.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"A conformance statement is a set of requirements for a desired implementation or a description of how a target application fulfills those requirements in a particular implementation.\" class=\"dict\" href=\"conformance-definitions.html#Conformance\"><b>Conformance</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"The identifier that is used to identify this conformance statement when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI).\" class=\"dict\" href=\"conformance-definitions.html#Conformance.identifier\"><b>identifier</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Logical id to reference this statement<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The identifier that is used to identify this version of the conformance statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.version\"><b>version</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Logical id for this version of the statement<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A free text natural language name identifying the conformance statement.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Informal name for this conformance statement<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Name of Organization publishing this conformance statement.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.publisher\"><b>publisher</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Publishing Organization<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Contacts for Organization relevant to this conformance statement. The contacts may be a website, email, phone numbers, etc.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.telecom\"><b>telecom</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">Contacts for Organization<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></telecom>\r\n <<a title=\"A free text natural language description of the conformance statement and its use. Typically, this is used when the profile describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: A Conformance statement SHALL have at least one of description, software, or implementation\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Human description of the conformance statement<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The status of this conformance statement (this element modifies the meaning of other elements)\" class=\"dict\" href=\"conformance-definitions.html#Conformance.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"conformance-statement-status.html\">draft | active | retired<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A flag to indicate that this conformance statement is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.experimental\"><b>experimental</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">If for testing purposes, not real usage<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The date when the conformance statement was published.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.date\"><b>date</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Publication Date<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Software that is covered by this conformance statement. It is used when the profile describes the capabilities of a particular software version, independent of an installation.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.software\"><b>software</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-2: A Conformance statement SHALL have at least one of description, software, or implementation\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> Software that is covered by this conformance statement<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span> --></span>\r\n <<a title=\"Name software is known by.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.software.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">A name the software is known by<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The version identifier for the software covered by this statement.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.software.version\"><b>version</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Version covered by this statement<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Date this version of the software released.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.software.releaseDate\"><b>releaseDate</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Date this version released<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n </software>\r\n <<a title=\"Identifies a specific implementation instance that is described by the conformance statement - i.e. a particular installation, rather than the capabilities of a software program.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.implementation\"><b>implementation</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-2: A Conformance statement SHALL have at least one of description, software, or implementation\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> If this describes a specific instance<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span> --></span>\r\n <<a title=\"Information about the specific installation that this conformance statement relates to.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.implementation.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Describes this specific instance<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.implementation.url\"><b>url</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Base URL for the installation<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n </implementation>\r\n <<a title=\"The version of the FHIR specification on which this conformance statement is based.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.fhirVersion\"><b>fhirVersion</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#id\">id</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">FHIR Version<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A flag that indicates whether the application accepts unknown elements as part of a resource.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.acceptUnknown\"><b>acceptUnknown</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">True if application accepts unknown elements<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A list of the formats supported by this implementation.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.format\"><b>format</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..*</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://www.rfc-editor.org/bcp/bcp13.txt.html\">formats supported (xml | json | mime type)</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A list of profiles supported by the system. For a server, "supported by the system" means the system hosts/produces a set of recourses, conformant to a particular profile, and allows its clients to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.profile\"><b>profile</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"profile.html#Profile\">Profile</a>)</span> <span style=\"color: navy\">Profiles supported by the system</span><span style=\"color: Gray\"> --></span></profile>\r\n <<a title=\"A definition of the restful capabilities of the solution, if any.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest\"><b>rest</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-1: A Conformance statement SHALL have at least one of rest, messaging or document\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> If the endpoint is a RESTful one --></span>\r\n <<a title=\"Identifies whether this portion of the statement is describing ability to initiate or receive restful operations.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.mode\"><b>mode</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"restful-conformance-mode.html\">client | server</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Information about the system's restful capabilities that apply across all applications, such as security.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.documentation\"><b>documentation</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">General description of implementation</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Information about security of implementation.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.security\"><b>security</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> Information about security of implementation --></span>\r\n <<a title=\"Server adds CORS headers when responding to requests - this enables javascript applications to yuse the server.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.security.cors\"><b>cors</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Adds CORS Headers (http://enable-cors.org/)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Types of security services are supported/required by the system.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.security.service\"><b>service</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"restful-security-service.html\">OAuth | OAuth2 | NTLM | Basic | Kerberos</a></span><span style=\"color: Gray\"> --></span></service>\r\n <<a title=\"General description of how security works.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.security.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">General description of how security works</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Certificates associated with security profiles.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.security.certificate\"><b>certificate</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Certificates associated with security profiles --></span>\r\n <<a title=\"Mime type for certificate.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.security.certificate.type\"><b>type</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://www.rfc-editor.org/bcp/bcp13.txt.html\">Mime type for certificate</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Actual certificate.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.security.certificate.blob\"><b>blob</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#base64Binary\">base64Binary</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Actual certificate</span><span style=\"color: Gray\"> --></span>\r\n </certificate>\r\n </security>\r\n <<a title=\"A specification of the restful capabilities of the solution for a specific resource type.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource\"><b>resource</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..*</b></span> Resource served on the REST interface --></span>\r\n <<a title=\"A type of resource exposed via the restful interface.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.type\"><b>type</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"resource-types.html\">A resource type that is supported</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A specification of the profile that describes the solution's support for the resource, including any constraints on cardinality, bindings, lengths or other limitations.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.profile\"><b>profile</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"profile.html#Profile\">Profile</a>)</span> <span style=\"color: navy\">What structural features are supported</span><span style=\"color: Gray\"> --></span></profile>\r\n <<a title=\"Identifies a restful operation supported by the solution.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.operation\"><b>operation</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..*</b></span> What operations are supported? --></span>\r\n <<a title=\"Coded identifier of the operation, supported by the system resource.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.operation.code\"><b>code</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"type-restful-operation.html\">read | vread | update | delete | history-instance | validate | history-type | create | search-type</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Guidance specific to the implementation of this operation, such as 'delete is a logical delete' or 'updates are only allowed with version id' or 'creates permitted from pre-authorized certificates only'.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.operation.documentation\"><b>documentation</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Anything special about operation behavior</span><span style=\"color: Gray\"> --></span>\r\n </operation>\r\n <<a title=\"A flag for whether the server is able to return past versions as part of the vRead operation.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.readHistory\"><b>readHistory</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Whether vRead can return past versions</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A flag to indicate that the server allows the client to create new identities on the server. If the update operation is used (client) or allowed (server) to a new location where a resource doesn't already exist. This means that the server allows the client to create new identities on the server.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.updateCreate\"><b>updateCreate</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">If allows/uses update to a new location</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A list of _include values supported by the server.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.searchInclude\"><b>searchInclude</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: navy\">_include values supported by the server</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Additional search parameters for implementations to support and/or make use of.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.searchParam\"><b>searchParam</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Additional search params defined --></span>\r\n <<a title=\"The name of the search parameter used in the interface.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.searchParam.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Name of search parameter</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.searchParam.definition\"><b>definition</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Source of definition for parameter</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The type of value a search parameter refers to, and how the content is interpreted.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.searchParam.type\"><b>type</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"search-param-type.html\">number | date | string | token | reference | composite | quantity</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.searchParam.documentation\"><b>documentation</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Server-specific usage</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Types of resource (if a resource is referenced).\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.searchParam.target\"><b>target</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"resource-types.html\">Types of resource (if a resource reference)</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Chained names supported.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.searchParam.chain\"><b>chain</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: navy\">Chained names supported</span><span style=\"color: Gray\"> --></span>\r\n </searchParam>\r\n </resource>\r\n <<a title=\"A specification of restful operations supported by the system.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.operation\"><b>operation</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> What operations are supported? --></span>\r\n <<a title=\"A coded identifier of the operation, supported by the system.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.operation.code\"><b>code</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"system-restful-operation.html\">transaction | search-system | history-system</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Guidance specific to the implementation of this operation, such as limitations on the kind of transactions allowed, or information about system wide search is implemented.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.operation.documentation\"><b>documentation</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Anything special about operation behavior</span><span style=\"color: Gray\"> --></span>\r\n </operation>\r\n <<a title=\"Definition of a named query and its parameters and their meaning.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.query\"><b>query</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Definition of a named query --></span>\r\n <<a title=\"The name of a query, which is used in the _query parameter when the query is called.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.query.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Special named queries (_query=)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identifies the custom query, defined either in FHIR core or another profile.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.query.definition\"><b>definition</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Where query is defined</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Additional information about how the query functions in this particular implementation.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.query.documentation\"><b>documentation</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Additional usage guidance</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identifies which of the parameters for the named query are supported.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.query.parameter\"><b>parameter</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\">Content as for Conformance.rest.resource.searchParam</span> <span style=\"color: navy\">Parameter for the named query</span><span style=\"color: Gray\"> --></span></parameter>\r\n </query>\r\n <<a title=\"A list of profiles that this server implements for accepting documents in the mailbox. If this list is empty, then documents are not accepted. The base specification has the profile identifier "http://hl7.org/fhir/documents/mailbox". Other specifications can declare their own identifier for this purpose.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.documentMailbox\"><b>documentMailbox</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: navy\">How documents are accepted in /Mailbox</span><span style=\"color: Gray\"> --></span>\r\n </rest>\r\n <<a title=\"A description of the messaging capabilities of the solution.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging\"><b>messaging</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-1: A Conformance statement SHALL have at least one of rest, messaging or document\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> If messaging is supported --></span>\r\n <<a title=\"An address to which messages and/or replies are to be sent.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.endpoint\"><b>endpoint</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-3: Messaging end point is required (and is only permitted) when statement is for an implementation\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Actual endpoint being described</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Length if the receiver's reliable messaging cache (if a receiver) or how long the cache length on the receiver should be (if a sender).\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.reliableCache\"><b>reliableCache</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Reliable Message Cache Length</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Documentation about the system's messaging capabilities for this endpoint not otherwise documented by the conformance statement. For example, process for becoming an authorized messaging exchange partner.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.documentation\"><b>documentation</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Messaging interface behavior details</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A description of the solution's support for an event at this end point.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.event\"><b>event</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..*</b></span> Declare support for this event --></span>\r\n <<a title=\"A coded identifier of a supported messaging event.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.event.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Coding\">Coding</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"message-events.html\">Event type</a></span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"The impact of the content of the message.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.event.category\"><b>category</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"message-significance-category.html\">Consequence | Currency | Notification</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The mode of this event declaration - whether application is sender or receiver.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.event.mode\"><b>mode</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"message-conformance-event-mode.html\">sender | receiver</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A list of the messaging transport protocol(s) identifiers, supported by this endpoint.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.event.protocol\"><b>protocol</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Coding\">Coding</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"message-transport.html\">http | ftp | mllp +</a></span><span style=\"color: Gray\"> --></span></protocol>\r\n <<a title=\"A resource associated with the event. This is the resource that defines the event.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.event.focus\"><b>focus</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"resource-types.html\">Resource that's focus of message</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Information about the request for this event.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.event.request\"><b>request</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"profile.html#Profile\">Profile</a>)</span> <span style=\"color: navy\">Profile that describes the request</span><span style=\"color: Gray\"> --></span></request>\r\n <<a title=\"Information about the response for this event.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.event.response\"><b>response</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"profile.html#Profile\">Profile</a>)</span> <span style=\"color: navy\">Profile that describes the response</span><span style=\"color: Gray\"> --></span></response>\r\n <<a title=\"Guidance on how this event is handled, such as internal system trigger points, business rules, etc.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.event.documentation\"><b>documentation</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Endpoint-specific event documentation</span><span style=\"color: Gray\"> --></span>\r\n </event>\r\n </messaging>\r\n <<a title=\"A document definition.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.document\"><b>document</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-1: A Conformance statement SHALL have at least one of rest, messaging or document\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> Document definition --></span>\r\n <<a title=\"Mode of this document declaration - whether application is producer or consumer.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.document.mode\"><b>mode</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"document-mode.html\">producer | consumer</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A description of how the application supports or uses the specified document profile. For example, when are documents created, what action is taken with consumed documents, etc.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.document.documentation\"><b>documentation</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Description of document support</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A constraint on a resource used in the document.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.document.profile\"><b>profile</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"profile.html#Profile\">Profile</a>)</span> <span style=\"color: navy\">Constraint on a resource used in the document</span><span style=\"color: Gray\"> --></span></profile>\r\n </document>\r\n</Conformance>\r\n</pre></div>"
},
"name": "conformance",
"publisher": "FHIR Project",
"description": "Basic Profile. A conformance statement is a set of requirements for a desired implementation or a description of how a target application fulfills those requirements in a particular implementation.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage Conformance statements are used in one of three ways: \r\n\r\nDescribe an actual implementation In this scenario, the conformance statement describes the capabilities of a deployed and configured solution available at a particular access point or set of access points. The statement describes exactly how to interface with that deployed solution and thus provides for a degree of self-configuration of software solutions. \r\n\r\nThis is the type of profile that FHIR restful solutions are expected to make available on invocation of the conformance operation. It is also the type of statement that forms a basis for the testing, certification or commissioning of specific software installations. \r\n\r\nA conformance statement is identified as being an implementation statement through the presence of the implementation element. \r\n\r\nDescribe software solution capabilities In this scenario, the conformance statement describes generic capabilities of a software application or component solution. The solution might be available for purchase or other acquisition and might be deployed and configured at any number of independent sites. Because it is not dependent on any particular implementation, the profile cannot provide specific details such as endpoint addresses. It may also need to document various configurations in which the application can be set up or describe the degree of customizability associated with the solution. \r\n\r\nThis type of statement may be used as a marketing tool by software and system developers to formally describe their capabilities. It can also be used as the basis for conformance testing of software solutions independent of a particular installation. \r\n\r\nA conformance statement is identified as being a software solution statement through the presence of the software element. \r\n\r\nDescribe a desired solution In this scenario, the conformance statement describes the capabilities of a desired system. It might be used as part of an architectural design process to document needed system capabilities, or might be used as part of an RFP process to formally document the requirements of a requested solution and to document the criteria by which proposals will be evaluated. \r\n\r\nA conformance statement is identified as being a requirements statement through the presence of the proposal element. \r\n\r\n\r\n\r\nThese three types of profiles can be used together. A requirements statement can be compared against the solution statements proffered by respondents to an RFP. A solution statement for a software package forms the starting point for the implementation statement associated with a particular installation of that software package.",
"structure": [
{
"type": "Conformance",
"publish": true,
"element": [
{
"path": "Conformance",
"definition": {
"short": "A conformance statement",
"formal": "A conformance statement is a set of requirements for a desired implementation or a description of how a target application fulfills those requirements in a particular implementation.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"constraint": [
{
"key": "2",
"name": "Details",
"severity": "error",
"human": "A Conformance statement SHALL have at least one of description, software, or implementation",
"xpath": "count(f:software | f:implementation | f:description) > 0"
},
{
"key": "1",
"name": "Content Required",
"severity": "error",
"human": "A Conformance statement SHALL have at least one of rest, messaging or document",
"xpath": "exists(f:rest) or exists(f:messaging) or exists(f:document)"
},
{
"key": "7",
"name": "Document unique",
"severity": "error",
"human": "The set of documents must be unique by the combination of profile & mode",
"xpath": "count(f:document[f:mode='producer'])=count(distinct-values(f:document[f:mode='producer']/f:profile/@value)) and count(f:document[f:mode='consumer'])=count(distinct-values(f:document[f:mode='consumer']/f:profile/@value))"
},
{
"key": "5",
"name": "Messaging endpoints unique",
"severity": "error",
"human": "The set of end points listed for messaging must be unique",
"xpath": "count(f:messaging/f:endpoint)=count(distinct-values(f:messaging/f:endpoint/@value))"
},
{
"key": "4",
"name": "End point populated when multiple",
"severity": "error",
"human": "If there is more than one messaging element, endpoint must be specified for each one",
"xpath": "count(f:messaging)<=1 or not(f:messaging[not(f:endpoint)])"
},
{
"key": "8",
"name": "Rest unique by mode",
"severity": "error",
"human": "There can only be one REST declaration per mode",
"xpath": "count(f:rest)=count(distinct-values(f:rest/f:mode/@value))"
}
],
"isModifier": false
}
},
{
"path": "Conformance.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Conformance.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Conformance.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "Conformance.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "Conformance.identifier",
"definition": {
"short": "Logical id to reference this statement",
"formal": "The identifier that is used to identify this conformance statement when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI).",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Conformance.version",
"definition": {
"short": "Logical id for this version of the statement",
"formal": "The identifier that is used to identify this version of the conformance statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.",
"comments": "There may be multiple different instances of a conformance statement that have the same identifier but different versions.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Conformance.name",
"definition": {
"short": "Informal name for this conformance statement",
"formal": "A free text natural language name identifying the conformance statement.",
"comments": "The name is not expected to be globally unique.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Conformance.publisher",
"definition": {
"short": "Publishing Organization",
"formal": "Name of Organization publishing this conformance statement.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Conformance.telecom",
"definition": {
"short": "Contacts for Organization",
"formal": "Contacts for Organization relevant to this conformance statement. The contacts may be a website, email, phone numbers, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "Contact"
}
],
"isModifier": false
}
},
{
"path": "Conformance.description",
"definition": {
"short": "Human description of the conformance statement",
"formal": "A free text natural language description of the conformance statement and its use. Typically, this is used when the profile describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.",
"comments": "This field cmay include the purpose of this conformance statement, comments about its context etc. This does not need to be populated if the description is adequately implied by the software or implementation details.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Conformance.status",
"definition": {
"short": "draft | active | retired",
"formal": "The status of this conformance statement.",
"comments": "This is not intended for use with actual conformance statements, but where conformance statements are used to describe possible or desired systems.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "ConformanceStatementStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/conformance-statement-status"
}
}
}
},
{
"path": "Conformance.experimental",
"definition": {
"short": "If for testing purposes, not real usage",
"formal": "A flag to indicate that this conformance statement is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"comments": "Allows filtering of conformance statements that are appropriate for use vs. not.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false
}
},
{
"path": "Conformance.date",
"definition": {
"short": "Publication Date",
"formal": "The date when the conformance statement was published.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false
}
},
{
"path": "Conformance.software",
"definition": {
"short": "Software that is covered by this conformance statement",
"formal": "Software that is covered by this conformance statement. It is used when the profile describes the capabilities of a particular software version, independent of an installation.",
"min": 0,
"max": "1",
"isModifier": false
}
},
{
"path": "Conformance.software.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Conformance.software.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Conformance.software.name",
"definition": {
"short": "A name the software is known by",
"formal": "Name software is known by.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Conformance.software.version",
"definition": {
"short": "Version covered by this statement",
"formal": "The version identifier for the software covered by this statement.",
"comments": "If possible, version should be specified, as statements are likely to be different for different versions of software.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Conformance.software.releaseDate",
"definition": {
"short": "Date this version released",
"formal": "Date this version of the software released.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false
}
},
{
"path": "Conformance.implementation",
"definition": {
"short": "If this describes a specific instance",
"formal": "Identifies a specific implementation instance that is described by the conformance statement - i.e. a particular installation, rather than the capabilities of a software program.",
"min": 0,
"max": "1",
"isModifier": false
}
},
{
"path": "Conformance.implementation.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Conformance.implementation.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Conformance.implementation.description",
"definition": {
"short": "Describes this specific instance",
"formal": "Information about the specific installation that this conformance statement relates to.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Conformance.implementation.url",
"definition": {
"short": "Base URL for the installation",
"formal": "A base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false
}
},
{
"path": "Conformance.fhirVersion",
"definition": {
"short": "FHIR Version",
"formal": "The version of the FHIR specification on which this conformance statement is based.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
],
"isModifier": false
}
},
{
"path": "Conformance.acceptUnknown",
"definition": {
"short": "True if application accepts unknown elements",
"formal": "A flag that indicates whether the application accepts unknown elements as part of a resource.",
"comments": "This is not about extensions, but about unknown elements in a resource - these can only arise as later versions of the specification are published, because this is the only place where such elements can be defined. Hence this element is about inter-version compatibility.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false
}
},
{
"path": "Conformance.format",
"definition": {
"short": "formats supported (xml | json | mime type)",
"formal": "A list of the formats supported by this implementation.",
"comments": "\"xml\" or \"json\" are allowed, which describe the simple encodings described in the specification (and imply appropriate bundle support). Otherwise, mime types are legal here.",
"min": 1,
"max": "*",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "MimeType",
"isExtensible": false,
"conformance": "required",
"referenceUri": "http://www.rfc-editor.org/bcp/bcp13.txt"
}
}
},
{
"path": "Conformance.profile",
"definition": {
"short": "Profiles supported by the system",
"formal": "A list of profiles supported by the system. For a server, \"supported by the system\" means the system hosts/produces a set of recourses, conformant to a particular profile, and allows its clients to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile.",
"comments": "Supported profiles are different to the profiles that apply to a particular resource in rest.resource.profile. The resource profile is a general statement of what features of the resource are supported overall by the system - the sum total of the facilities it supports. A supported profile is a deeper statement about the functionality of the data and services provided by the server (or used by the client). A typical case is a laboratory system that produces a set of different reports- this is the list of types of data that it publishes. A key aspect of declaring profiles here is the question of how the client converts knowledge that the server publishes this data into working with the data; the client can inspect individual resources to determine whether they conform to a particular profile, but how does it find the ones that does? It does so by searching using the _profile parameter, so any resources listed here must be valid values for the _profile resource (using the identifier in the target profile).\n\nTypical supported profiles cross resource types to describe a network of related resources, so they are listed here rather than by resource. However they do not need to describe more than one resource.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Profile"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest",
"definition": {
"short": "If the endpoint is a RESTful one",
"formal": "A definition of the restful capabilities of the solution, if any.",
"comments": "Multiple repetitions allow definition of both client and / or server behaviors or possibly behaviors under different configuration settings (for software or requirements statements).",
"min": 0,
"max": "*",
"constraint": [
{
"key": "10",
"name": "Query unique in rest mode",
"severity": "error",
"human": "A given query can only be described once per RESTful mode",
"xpath": "count(f:query)=count(distinct-values(f:query/f:name/@value))"
},
{
"key": "9",
"name": "Resource unique in rest mode",
"severity": "error",
"human": "A given resource can only be described once per RESTful mode",
"xpath": "count(f:resource)=count(distinct-values(f:resource/f:type/@value))"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.mode",
"definition": {
"short": "client | server",
"formal": "Identifies whether this portion of the statement is describing ability to initiate or receive restful operations.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "RestfulConformanceMode",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/restful-conformance-mode"
}
}
}
},
{
"path": "Conformance.rest.documentation",
"definition": {
"short": "General description of implementation",
"formal": "Information about the system's restful capabilities that apply across all applications, such as security.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.security",
"definition": {
"short": "Information about security of implementation",
"formal": "Information about security of implementation.",
"min": 0,
"max": "1",
"isModifier": false
}
},
{
"path": "Conformance.rest.security.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.security.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.security.cors",
"definition": {
"short": "Adds CORS Headers (http://enable-cors.org/)",
"formal": "Server adds CORS headers when responding to requests - this enables javascript applications to yuse the server.",
"comments": "The easiest CORS headers to add are Access-Control-Allow-Origin: * & Access-Control-Request-Method: GET, POST, PUT, DELETE.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.security.service",
"definition": {
"short": "OAuth | OAuth2 | NTLM | Basic | Kerberos",
"formal": "Types of security services are supported/required by the system.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "RestfulSecurityService",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/restful-security-service"
}
}
}
},
{
"path": "Conformance.rest.security.description",
"definition": {
"short": "General description of how security works",
"formal": "General description of how security works.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.security.certificate",
"definition": {
"short": "Certificates associated with security profiles",
"formal": "Certificates associated with security profiles.",
"min": 0,
"max": "*",
"isModifier": false
}
},
{
"path": "Conformance.rest.security.certificate.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.security.certificate.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.security.certificate.type",
"definition": {
"short": "Mime type for certificate",
"formal": "Mime type for certificate.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "MimeType",
"isExtensible": false,
"conformance": "required",
"referenceUri": "http://www.rfc-editor.org/bcp/bcp13.txt"
}
}
},
{
"path": "Conformance.rest.security.certificate.blob",
"definition": {
"short": "Actual certificate",
"formal": "Actual certificate.",
"min": 0,
"max": "1",
"type": [
{
"code": "base64Binary"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.resource",
"definition": {
"short": "Resource served on the REST interface",
"formal": "A specification of the restful capabilities of the solution for a specific resource type.",
"comments": "Max of one repetition per resource type.",
"min": 1,
"max": "*",
"constraint": [
{
"key": "11",
"name": "Operation unique in resource",
"severity": "error",
"human": "Operation codes must be unique in the context of a resource",
"xpath": "count(f:operation)=count(distinct-values(f:operation/f:code/@value))"
},
{
"key": "12",
"name": "SearchParam unique in resource",
"severity": "error",
"human": "Search parameter names must be unique in the context of a resource",
"xpath": "count(f:searchParam)=count(distinct-values(f:searchParam/f:name/@value))"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.resource.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.resource.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.resource.type",
"definition": {
"short": "A resource type that is supported",
"formal": "A type of resource exposed via the restful interface.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "ResourceType",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/resource-types"
}
}
}
},
{
"path": "Conformance.rest.resource.profile",
"definition": {
"short": "What structural features are supported",
"formal": "A specification of the profile that describes the solution's support for the resource, including any constraints on cardinality, bindings, lengths or other limitations.",
"comments": "The profile applies to all resources of this type - i.e. it is the superset of what is supported by the system.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Profile"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.resource.operation",
"definition": {
"short": "What operations are supported?",
"formal": "Identifies a restful operation supported by the solution.",
"min": 1,
"max": "*",
"isModifier": false
}
},
{
"path": "Conformance.rest.resource.operation.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.resource.operation.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.resource.operation.code",
"definition": {
"short": "read | vread | update | delete | history-instance | validate | history-type | create | search-type",
"formal": "Coded identifier of the operation, supported by the system resource.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "RestfulOperationType",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/type-restful-operation"
}
}
}
},
{
"path": "Conformance.rest.resource.operation.documentation",
"definition": {
"short": "Anything special about operation behavior",
"formal": "Guidance specific to the implementation of this operation, such as 'delete is a logical delete' or 'updates are only allowed with version id' or 'creates permitted from pre-authorized certificates only'.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.resource.readHistory",
"definition": {
"short": "Whether vRead can return past versions",
"formal": "A flag for whether the server is able to return past versions as part of the vRead operation.",
"comments": "It is useful to support the vRead operation for current operations, even if past versions aren't available.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.resource.updateCreate",
"definition": {
"short": "If allows/uses update to a new location",
"formal": "A flag to indicate that the server allows the client to create new identities on the server. If the update operation is used (client) or allowed (server) to a new location where a resource doesn't already exist. This means that the server allows the client to create new identities on the server.",
"comments": "Allowing the clients to create new identities on the server means that the system administrator needs to have confidence that the clients do not create clashing identities between them. Obviously, there is only one client, this won't happen. While creating identities on the client means that the clients need to be managed, it's much more convenient for many scenarios.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.resource.searchInclude",
"definition": {
"short": "_include values supported by the server",
"formal": "A list of _include values supported by the server.",
"comments": "If this list is empty, the server does not support includes.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.resource.searchParam",
"definition": {
"short": "Additional search params defined",
"formal": "Additional search parameters for implementations to support and/or make use of.",
"min": 0,
"max": "*",
"isModifier": false
}
},
{
"path": "Conformance.rest.resource.searchParam.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.resource.searchParam.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.resource.searchParam.name",
"definition": {
"short": "Name of search parameter",
"formal": "The name of the search parameter used in the interface.",
"comments": "Parameter names cannot overlap with standard parameter names, and standard parameters cannot be redefined.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.resource.searchParam.definition",
"definition": {
"short": "Source of definition for parameter",
"formal": "A formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter.",
"comments": "This SHALL be populated for all search parameters not defined as part of the core FHIR specification. The uri is the uri of the profile defining the parameter followed by \"#\" followed by the structure name and search parameter name.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.resource.searchParam.type",
"definition": {
"short": "number | date | string | token | reference | composite | quantity",
"formal": "The type of value a search parameter refers to, and how the content is interpreted.",
"comments": "While this can be looked up from the definition, it is included here as a convenience for systems that auto-generate a query interface based on the server conformance statement. It SHALL be the same as the type in the search parameter definition.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "SearchParamType",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/search-param-type"
}
}
}
},
{
"path": "Conformance.rest.resource.searchParam.documentation",
"definition": {
"short": "Server-specific usage",
"formal": "This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.resource.searchParam.target",
"definition": {
"short": "Types of resource (if a resource reference)",
"formal": "Types of resource (if a resource is referenced).",
"comments": "This SHALL be the same as or a proper subset of the resources listed in the search parameter definition.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "ResourceType",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/resource-types"
}
}
}
},
{
"path": "Conformance.rest.resource.searchParam.chain",
"definition": {
"short": "Chained names supported",
"formal": "Chained names supported.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.operation",
"definition": {
"short": "What operations are supported?",
"formal": "A specification of restful operations supported by the system.",
"min": 0,
"max": "*",
"isModifier": false
}
},
{
"path": "Conformance.rest.operation.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.operation.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.operation.code",
"definition": {
"short": "transaction | search-system | history-system",
"formal": "A coded identifier of the operation, supported by the system.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "RestfulOperationSystem",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/system-restful-operation"
}
}
}
},
{
"path": "Conformance.rest.operation.documentation",
"definition": {
"short": "Anything special about operation behavior",
"formal": "Guidance specific to the implementation of this operation, such as limitations on the kind of transactions allowed, or information about system wide search is implemented.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.query",
"definition": {
"short": "Definition of a named query",
"formal": "Definition of a named query and its parameters and their meaning.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "13",
"name": "SearchParam unique in query",
"severity": "error",
"human": "Search parameter names must be unique in the context of a query",
"xpath": "count(f:parameter)=count(distinct-values(f:parameter/f:name/@value))"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.query.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.query.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.query.name",
"definition": {
"short": "Special named queries (_query=)",
"formal": "The name of a query, which is used in the _query parameter when the query is called.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.query.definition",
"definition": {
"short": "Where query is defined",
"formal": "Identifies the custom query, defined either in FHIR core or another profile.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.query.documentation",
"definition": {
"short": "Additional usage guidance",
"formal": "Additional information about how the query functions in this particular implementation.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Conformance.rest.query.parameter",
"definition": {
"short": "Parameter for the named query",
"formal": "Identifies which of the parameters for the named query are supported.",
"comments": "This SHALL be a proper subset of the parameters defined on the query definition.",
"min": 0,
"max": "*",
"nameReference": "Conformance.rest.resource.searchParam",
"isModifier": false
}
},
{
"path": "Conformance.rest.documentMailbox",
"definition": {
"short": "How documents are accepted in /Mailbox",
"formal": "A list of profiles that this server implements for accepting documents in the mailbox. If this list is empty, then documents are not accepted. The base specification has the profile identifier \"http://hl7.org/fhir/documents/mailbox\". Other specifications can declare their own identifier for this purpose.",
"comments": "If a server accepts messages on the /Mailbox end-point, it declares this in the messaging elements.",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
],
"isModifier": false
}
},
{
"path": "Conformance.messaging",
"definition": {
"short": "If messaging is supported",
"formal": "A description of the messaging capabilities of the solution.",
"comments": "Multiple repetitions allow the documentation of multiple endpoints per solution.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "3",
"name": "End points for Implementations",
"severity": "error",
"human": "Messaging end point is required (and is only permitted) when statement is for an implementation",
"xpath": "exists(f:endpoint) = exists(parent::f:Conformance/f:implementation)"
},
{
"key": "6",
"name": "Event unique",
"severity": "error",
"human": "The set of events per messaging endpoint must be unique by the combination of code & mode",
"xpath": "count(f:event[f:mode='sender'])=count(distinct-values(f:event[f:mode='sender']/f:code/@value)) and count(f:event[f:mode='receiver'])=count(distinct-values(f:event[f:mode='receiver']/f:code/@value))"
}
],
"isModifier": false
}
},
{
"path": "Conformance.messaging.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Conformance.messaging.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Conformance.messaging.endpoint",
"definition": {
"short": "Actual endpoint being described",
"formal": "An address to which messages and/or replies are to be sent.",
"comments": "For solutions that do not use network addresses for routing, it can be just an identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false
}
},
{
"path": "Conformance.messaging.reliableCache",
"definition": {
"short": "Reliable Message Cache Length",
"formal": "Length if the receiver's reliable messaging cache (if a receiver) or how long the cache length on the receiver should be (if a sender).",
"comments": "If this value is missing then the application does not implement (receiver) or depend on (sender) reliable messaging.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isModifier": false
}
},
{
"path": "Conformance.messaging.documentation",
"definition": {
"short": "Messaging interface behavior details",
"formal": "Documentation about the system's messaging capabilities for this endpoint not otherwise documented by the conformance statement. For example, process for becoming an authorized messaging exchange partner.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Conformance.messaging.event",
"definition": {
"short": "Declare support for this event",
"formal": "A description of the solution's support for an event at this end point.",
"comments": "The same event may be listed up to two times - once as sender and once as receiver.",
"min": 1,
"max": "*",
"isModifier": false
}
},
{
"path": "Conformance.messaging.event.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Conformance.messaging.event.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Conformance.messaging.event.code",
"definition": {
"short": "Event type",
"formal": "A coded identifier of a supported messaging event.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isModifier": false,
"binding": {
"name": "MessageEvent",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/message-events"
}
}
}
},
{
"path": "Conformance.messaging.event.category",
"definition": {
"short": "Consequence | Currency | Notification",
"formal": "The impact of the content of the message.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "MessageSignificanceCategory",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/message-significance-category"
}
}
}
},
{
"path": "Conformance.messaging.event.mode",
"definition": {
"short": "sender | receiver",
"formal": "The mode of this event declaration - whether application is sender or receiver.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "ConformanceEventMode",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/message-conformance-event-mode"
}
}
}
},
{
"path": "Conformance.messaging.event.protocol",
"definition": {
"short": "http | ftp | mllp +",
"formal": "A list of the messaging transport protocol(s) identifiers, supported by this endpoint.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"isModifier": false,
"binding": {
"name": "MessageTransport",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/message-transport"
}
}
}
},
{
"path": "Conformance.messaging.event.focus",
"definition": {
"short": "Resource that's focus of message",
"formal": "A resource associated with the event. This is the resource that defines the event.",
"comments": "This SHALL be provided if the event type supports multiple different resource types.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "ResourceType",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/resource-types"
}
}
}
},
{
"path": "Conformance.messaging.event.request",
"definition": {
"short": "Profile that describes the request",
"formal": "Information about the request for this event.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Profile"
}
],
"isModifier": false
}
},
{
"path": "Conformance.messaging.event.response",
"definition": {
"short": "Profile that describes the response",
"formal": "Information about the response for this event.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Profile"
}
],
"isModifier": false
}
},
{
"path": "Conformance.messaging.event.documentation",
"definition": {
"short": "Endpoint-specific event documentation",
"formal": "Guidance on how this event is handled, such as internal system trigger points, business rules, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Conformance.document",
"definition": {
"short": "Document definition",
"formal": "A document definition.",
"min": 0,
"max": "*",
"isModifier": false
}
},
{
"path": "Conformance.document.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Conformance.document.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Conformance.document.mode",
"definition": {
"short": "producer | consumer",
"formal": "Mode of this document declaration - whether application is producer or consumer.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "DocumentMode",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/document-mode"
}
}
}
},
{
"path": "Conformance.document.documentation",
"definition": {
"short": "Description of document support",
"formal": "A description of how the application supports or uses the specified document profile. For example, when are documents created, what action is taken with consumed documents, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Conformance.document.profile",
"definition": {
"short": "Constraint on a resource used in the document",
"formal": "A constraint on a resource used in the document.",
"comments": "The first resource is the document resource.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Profile"
}
],
"isModifier": false
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "date",
"type": "date",
"documentation": "The conformance statement publication date",
"xpath": "f:Conformance/f:date"
},
{
"name": "description",
"type": "string",
"documentation": "Text search in the description of the conformance statement",
"xpath": "f:Conformance/f:description"
},
{
"name": "event",
"type": "token",
"documentation": "Event code in a conformance statement",
"xpath": "f:Conformance/f:messaging/f:event/f:code"
},
{
"name": "fhirversion",
"type": "token",
"documentation": "The version of FHIR",
"xpath": "f:Conformance/f:version"
},
{
"name": "format",
"type": "token",
"documentation": "formats supported (xml | json | mime type)",
"xpath": "f:Conformance/f:format"
},
{
"name": "identifier",
"type": "token",
"documentation": "The identifier of the conformance statement",
"xpath": "f:Conformance/f:identifier"
},
{
"name": "mode",
"type": "token",
"documentation": "Mode - restful (server/client) or messaging (sender/receiver)",
"xpath": "f:Conformance/f:rest/f:mode"
},
{
"name": "name",
"type": "string",
"documentation": "Name of the conformance statement",
"xpath": "f:Conformance/f:name"
},
{
"name": "profile",
"type": "reference",
"documentation": "A profile id invoked in a conformance statement",
"xpath": "f:Conformance/f:rest/f:resource/f:profile"
},
{
"name": "publisher",
"type": "string",
"documentation": "Name of the publisher of the conformance statement",
"xpath": "f:Conformance/f:publisher"
},
{
"name": "resource",
"type": "token",
"documentation": "Name of a resource mentioned in a conformance statement",
"xpath": "f:Conformance/f:rest/f:resource/f:type"
},
{
"name": "security",
"type": "token",
"documentation": "Information about security of implementation",
"xpath": "f:Conformance/f:rest/f:security"
},
{
"name": "software",
"type": "string",
"documentation": "Part of a the name of a software application",
"xpath": "f:Conformance/f:software/f:name"
},
{
"name": "status",
"type": "token",
"documentation": "The current status of the conformance statement",
"xpath": "f:Conformance/f:status"
},
{
"name": "supported-profile",
"type": "reference",
"documentation": "Profiles supported by the system",
"xpath": "f:Conformance/f:profile"
},
{
"name": "version",
"type": "token",
"documentation": "The version identifier of the conformance statement",
"xpath": "f:Conformance/f:version"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"A conformance statement is a set of requirements for a desired implementation or a description of how a target application fulfills those requirements in a particular implementation.\" class=\"dict\" href=\"conformance-definitions.html#Conformance\"><b>Conformance</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"The identifier that is used to identify this conformance statement when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI).\" class=\"dict\" href=\"conformance-definitions.html#Conformance.identifier\"><b>identifier</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Logical id to reference this statement<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The identifier that is used to identify this version of the conformance statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.version\"><b>version</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Logical id for this version of the statement<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A free text natural language name identifying the conformance statement.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Informal name for this conformance statement<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Name of Organization publishing this conformance statement.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.publisher\"><b>publisher</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Publishing Organization<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Contacts for Organization relevant to this conformance statement. The contacts may be a website, email, phone numbers, etc.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.telecom\"><b>telecom</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">Contacts for Organization<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></telecom>\r\n <<a title=\"A free text natural language description of the conformance statement and its use. Typically, this is used when the profile describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: A Conformance statement SHALL have at least one of description, software, or implementation\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Human description of the conformance statement<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The status of this conformance statement (this element modifies the meaning of other elements)\" class=\"dict\" href=\"conformance-definitions.html#Conformance.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"conformance-statement-status.html\">draft | active | retired<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A flag to indicate that this conformance statement is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.experimental\"><b>experimental</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">If for testing purposes, not real usage<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The date when the conformance statement was published.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.date\"><b>date</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Publication Date<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Software that is covered by this conformance statement. It is used when the profile describes the capabilities of a particular software version, independent of an installation.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.software\"><b>software</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-2: A Conformance statement SHALL have at least one of description, software, or implementation\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> Software that is covered by this conformance statement<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span> --></span>\r\n <<a title=\"Name software is known by.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.software.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">A name the software is known by<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The version identifier for the software covered by this statement.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.software.version\"><b>version</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Version covered by this statement<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Date this version of the software released.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.software.releaseDate\"><b>releaseDate</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Date this version released<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n </software>\r\n <<a title=\"Identifies a specific implementation instance that is described by the conformance statement - i.e. a particular installation, rather than the capabilities of a software program.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.implementation\"><b>implementation</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-2: A Conformance statement SHALL have at least one of description, software, or implementation\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> If this describes a specific instance<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span> --></span>\r\n <<a title=\"Information about the specific installation that this conformance statement relates to.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.implementation.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Describes this specific instance<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.implementation.url\"><b>url</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Base URL for the installation<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n </implementation>\r\n <<a title=\"The version of the FHIR specification on which this conformance statement is based.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.fhirVersion\"><b>fhirVersion</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#id\">id</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">FHIR Version<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A flag that indicates whether the application accepts unknown elements as part of a resource.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.acceptUnknown\"><b>acceptUnknown</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">True if application accepts unknown elements<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A list of the formats supported by this implementation.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.format\"><b>format</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..*</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://www.rfc-editor.org/bcp/bcp13.txt.html\">formats supported (xml | json | mime type)</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A list of profiles supported by the system. For a server, "supported by the system" means the system hosts/produces a set of recourses, conformant to a particular profile, and allows its clients to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.profile\"><b>profile</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"profile.html#Profile\">Profile</a>)</span> <span style=\"color: navy\">Profiles supported by the system</span><span style=\"color: Gray\"> --></span></profile>\r\n <<a title=\"A definition of the restful capabilities of the solution, if any.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest\"><b>rest</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-1: A Conformance statement SHALL have at least one of rest, messaging or document\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> If the endpoint is a RESTful one --></span>\r\n <<a title=\"Identifies whether this portion of the statement is describing ability to initiate or receive restful operations.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.mode\"><b>mode</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"restful-conformance-mode.html\">client | server</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Information about the system's restful capabilities that apply across all applications, such as security.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.documentation\"><b>documentation</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">General description of implementation</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Information about security of implementation.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.security\"><b>security</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> Information about security of implementation --></span>\r\n <<a title=\"Server adds CORS headers when responding to requests - this enables javascript applications to yuse the server.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.security.cors\"><b>cors</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Adds CORS Headers (http://enable-cors.org/)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Types of security services are supported/required by the system.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.security.service\"><b>service</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"restful-security-service.html\">OAuth | OAuth2 | NTLM | Basic | Kerberos</a></span><span style=\"color: Gray\"> --></span></service>\r\n <<a title=\"General description of how security works.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.security.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">General description of how security works</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Certificates associated with security profiles.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.security.certificate\"><b>certificate</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Certificates associated with security profiles --></span>\r\n <<a title=\"Mime type for certificate.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.security.certificate.type\"><b>type</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://www.rfc-editor.org/bcp/bcp13.txt.html\">Mime type for certificate</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Actual certificate.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.security.certificate.blob\"><b>blob</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#base64Binary\">base64Binary</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Actual certificate</span><span style=\"color: Gray\"> --></span>\r\n </certificate>\r\n </security>\r\n <<a title=\"A specification of the restful capabilities of the solution for a specific resource type.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource\"><b>resource</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..*</b></span> Resource served on the REST interface --></span>\r\n <<a title=\"A type of resource exposed via the restful interface.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.type\"><b>type</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"resource-types.html\">A resource type that is supported</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A specification of the profile that describes the solution's support for the resource, including any constraints on cardinality, bindings, lengths or other limitations.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.profile\"><b>profile</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"profile.html#Profile\">Profile</a>)</span> <span style=\"color: navy\">What structural features are supported</span><span style=\"color: Gray\"> --></span></profile>\r\n <<a title=\"Identifies a restful operation supported by the solution.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.operation\"><b>operation</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..*</b></span> What operations are supported? --></span>\r\n <<a title=\"Coded identifier of the operation, supported by the system resource.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.operation.code\"><b>code</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"type-restful-operation.html\">read | vread | update | delete | history-instance | validate | history-type | create | search-type</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Guidance specific to the implementation of this operation, such as 'delete is a logical delete' or 'updates are only allowed with version id' or 'creates permitted from pre-authorized certificates only'.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.operation.documentation\"><b>documentation</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Anything special about operation behavior</span><span style=\"color: Gray\"> --></span>\r\n </operation>\r\n <<a title=\"A flag for whether the server is able to return past versions as part of the vRead operation.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.readHistory\"><b>readHistory</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Whether vRead can return past versions</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A flag to indicate that the server allows the client to create new identities on the server. If the update operation is used (client) or allowed (server) to a new location where a resource doesn't already exist. This means that the server allows the client to create new identities on the server.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.updateCreate\"><b>updateCreate</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">If allows/uses update to a new location</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A list of _include values supported by the server.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.searchInclude\"><b>searchInclude</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: navy\">_include values supported by the server</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Additional search parameters for implementations to support and/or make use of.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.searchParam\"><b>searchParam</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Additional search params defined --></span>\r\n <<a title=\"The name of the search parameter used in the interface.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.searchParam.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Name of search parameter</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.searchParam.definition\"><b>definition</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Source of definition for parameter</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The type of value a search parameter refers to, and how the content is interpreted.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.searchParam.type\"><b>type</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"search-param-type.html\">number | date | string | token | reference | composite | quantity</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.searchParam.documentation\"><b>documentation</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Server-specific usage</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Types of resource (if a resource is referenced).\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.searchParam.target\"><b>target</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"resource-types.html\">Types of resource (if a resource reference)</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Chained names supported.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.resource.searchParam.chain\"><b>chain</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: navy\">Chained names supported</span><span style=\"color: Gray\"> --></span>\r\n </searchParam>\r\n </resource>\r\n <<a title=\"A specification of restful operations supported by the system.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.operation\"><b>operation</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> What operations are supported? --></span>\r\n <<a title=\"A coded identifier of the operation, supported by the system.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.operation.code\"><b>code</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"system-restful-operation.html\">transaction | search-system | history-system</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Guidance specific to the implementation of this operation, such as limitations on the kind of transactions allowed, or information about system wide search is implemented.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.operation.documentation\"><b>documentation</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Anything special about operation behavior</span><span style=\"color: Gray\"> --></span>\r\n </operation>\r\n <<a title=\"Definition of a named query and its parameters and their meaning.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.query\"><b>query</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Definition of a named query --></span>\r\n <<a title=\"The name of a query, which is used in the _query parameter when the query is called.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.query.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Special named queries (_query=)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identifies the custom query, defined either in FHIR core or another profile.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.query.definition\"><b>definition</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Where query is defined</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Additional information about how the query functions in this particular implementation.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.query.documentation\"><b>documentation</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Additional usage guidance</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identifies which of the parameters for the named query are supported.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.query.parameter\"><b>parameter</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\">Content as for Conformance.rest.resource.searchParam</span> <span style=\"color: navy\">Parameter for the named query</span><span style=\"color: Gray\"> --></span></parameter>\r\n </query>\r\n <<a title=\"A list of profiles that this server implements for accepting documents in the mailbox. If this list is empty, then documents are not accepted. The base specification has the profile identifier "http://hl7.org/fhir/documents/mailbox". Other specifications can declare their own identifier for this purpose.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.rest.documentMailbox\"><b>documentMailbox</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: navy\">How documents are accepted in /Mailbox</span><span style=\"color: Gray\"> --></span>\r\n </rest>\r\n <<a title=\"A description of the messaging capabilities of the solution.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging\"><b>messaging</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-1: A Conformance statement SHALL have at least one of rest, messaging or document\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> If messaging is supported --></span>\r\n <<a title=\"An address to which messages and/or replies are to be sent.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.endpoint\"><b>endpoint</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-3: Messaging end point is required (and is only permitted) when statement is for an implementation\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Actual endpoint being described</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Length if the receiver's reliable messaging cache (if a receiver) or how long the cache length on the receiver should be (if a sender).\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.reliableCache\"><b>reliableCache</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Reliable Message Cache Length</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Documentation about the system's messaging capabilities for this endpoint not otherwise documented by the conformance statement. For example, process for becoming an authorized messaging exchange partner.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.documentation\"><b>documentation</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Messaging interface behavior details</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A description of the solution's support for an event at this end point.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.event\"><b>event</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..*</b></span> Declare support for this event --></span>\r\n <<a title=\"A coded identifier of a supported messaging event.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.event.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Coding\">Coding</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"message-events.html\">Event type</a></span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"The impact of the content of the message.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.event.category\"><b>category</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"message-significance-category.html\">Consequence | Currency | Notification</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The mode of this event declaration - whether application is sender or receiver.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.event.mode\"><b>mode</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"message-conformance-event-mode.html\">sender | receiver</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A list of the messaging transport protocol(s) identifiers, supported by this endpoint.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.event.protocol\"><b>protocol</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Coding\">Coding</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"message-transport.html\">http | ftp | mllp +</a></span><span style=\"color: Gray\"> --></span></protocol>\r\n <<a title=\"A resource associated with the event. This is the resource that defines the event.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.event.focus\"><b>focus</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"resource-types.html\">Resource that's focus of message</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Information about the request for this event.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.event.request\"><b>request</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"profile.html#Profile\">Profile</a>)</span> <span style=\"color: navy\">Profile that describes the request</span><span style=\"color: Gray\"> --></span></request>\r\n <<a title=\"Information about the response for this event.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.event.response\"><b>response</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"profile.html#Profile\">Profile</a>)</span> <span style=\"color: navy\">Profile that describes the response</span><span style=\"color: Gray\"> --></span></response>\r\n <<a title=\"Guidance on how this event is handled, such as internal system trigger points, business rules, etc.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.messaging.event.documentation\"><b>documentation</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Endpoint-specific event documentation</span><span style=\"color: Gray\"> --></span>\r\n </event>\r\n </messaging>\r\n <<a title=\"A document definition.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.document\"><b>document</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-1: A Conformance statement SHALL have at least one of rest, messaging or document\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> Document definition --></span>\r\n <<a title=\"Mode of this document declaration - whether application is producer or consumer.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.document.mode\"><b>mode</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"document-mode.html\">producer | consumer</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A description of how the application supports or uses the specified document profile. For example, when are documents created, what action is taken with consumed documents, etc.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.document.documentation\"><b>documentation</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Description of document support</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A constraint on a resource used in the document.\" class=\"dict\" href=\"conformance-definitions.html#Conformance.document.profile\"><b>profile</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"profile.html#Profile\">Profile</a>)</span> <span style=\"color: navy\">Constraint on a resource used in the document</span><span style=\"color: Gray\"> --></span></profile>\r\n </document>\r\n</Conformance>\r\n</pre></div>"
},
{
"title": "\"device\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/device",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/device.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"This resource identifies an instance of a manufactured thing that is used in the provision of healthcare without being substantially changed through that activity. The device may be a machine, an insert, a computer, an application, etc. This includes durable (reusable) medical equipment as well as disposable equipment used for diagnostic, treatment, and research for healthcare and public health.\" class=\"dict\" href=\"device-definitions.html#Device\"><b>Device</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Identifiers assigned to this device by various organizations. The most likely organizations to assign identifiers are the manufacturer and the owner, though regulatory agencies may also assign an identifier. The identifiers identify the particular device, not the kind of device.\" class=\"dict\" href=\"device-definitions.html#Device.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Instance id from manufacturer, owner and others</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"A kind of this device.\" class=\"dict\" href=\"device-definitions.html#Device.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://hit-testing.nist.gov:13110/rtmms/index.htm.html\">What kind of device this is</a></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"A name of the manufacturer.\" class=\"dict\" href=\"device-definitions.html#Device.manufacturer\"><b>manufacturer</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Name of device manufacturer</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The "model" - an identifier assigned by the manufacturer to identify the product by its type. This number is shared by the all devices sold as the same type.\" class=\"dict\" href=\"device-definitions.html#Device.model\"><b>model</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Model id assigned by the manufacturer</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware.\" class=\"dict\" href=\"device-definitions.html#Device.version\"><b>version</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Version number (i.e. software)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Date of expiry of this device (if applicable).\" class=\"dict\" href=\"device-definitions.html#Device.expiry\"><b>expiry</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#date\">date</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Date of expiry of this device (if applicable)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"FDA Mandated Unique Device Identifier. Use the human readable information (the content that the user sees, which is sometimes different to the exact syntax represented in the barcode) - see http://www.fda.gov/MedicalDevices/DeviceRegulationandGuidance/UniqueDeviceIdentification/default.htm.\" class=\"dict\" href=\"device-definitions.html#Device.udi\"><b>udi</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">FDA Mandated Unique Device Identifier</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Lot number assigned by the manufacturer.\" class=\"dict\" href=\"device-definitions.html#Device.lotNumber\"><b>lotNumber</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Lot number of manufacture</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"An organization that is responsible for the provision and ongoing maintenance of the device.\" class=\"dict\" href=\"device-definitions.html#Device.owner\"><b>owner</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">Organization responsible for device</span><span style=\"color: Gray\"> --></span></owner>\r\n <<a title=\"The resource may be found in a literal location (i.e. GPS coordinates), a logical place (i.e. "in/with the patient"), or a coded location.\" class=\"dict\" href=\"device-definitions.html#Device.location\"><b>location</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">Where the resource is found</span><span style=\"color: Gray\"> --></span></location>\r\n <<a title=\"Patient information, if the resource is affixed to a person.\" class=\"dict\" href=\"device-definitions.html#Device.patient\"><b>patient</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">If the resource is affixed to a person</span><span style=\"color: Gray\"> --></span></patient>\r\n <<a title=\"Contact details for an organization or a particular human that is responsible for the device.\" class=\"dict\" href=\"device-definitions.html#Device.contact\"><b>contact</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">Details for human/organization for support</span><span style=\"color: Gray\"> --></span></contact>\r\n <<a title=\"A network address on which the device may be contacted directly.\" class=\"dict\" href=\"device-definitions.html#Device.url\"><b>url</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Network address to contact device</span><span style=\"color: Gray\"> --></span>\r\n</Device>\r\n</pre></div>"
},
"name": "device",
"publisher": "FHIR Project",
"description": "Basic Profile. This resource identifies an instance of a manufactured thing that is used in the provision of healthcare without being substantially changed through that activity. The device may be a machine, an insert, a computer, an application, etc. This includes durable (reusable) medical equipment as well as disposable equipment used for diagnostic, treatment, and research for healthcare and public health.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage This resource is primarily used for recording which device performed an action and can also be used to track device location. It is also used for prescribing and dispensing devices for patient use. If the device is implanted in a patient, then the patient element will be present, and there would be no location. \r\n\r\nDevices that are implanted in a patient differ from medications because they are not \"used up\" - they remain active in a patient in an ongoing fashion. The Medication resource SHOULD not be used to represent implanted devices.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"structure": [
{
"type": "Device",
"publish": true,
"element": [
{
"path": "Device",
"definition": {
"short": "An instance of a manufactured thing that is used in the provision of healthcare",
"formal": "This resource identifies an instance of a manufactured thing that is used in the provision of healthcare without being substantially changed through that activity. The device may be a machine, an insert, a computer, an application, etc. This includes durable (reusable) medical equipment as well as disposable equipment used for diagnostic, treatment, and research for healthcare and public health.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Device"
}
]
}
},
{
"path": "Device.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Device.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Device.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "Device.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "Device.identifier",
"definition": {
"short": "Instance id from manufacturer, owner and others",
"formal": "Identifiers assigned to this device by various organizations. The most likely organizations to assign identifiers are the manufacturer and the owner, though regulatory agencies may also assign an identifier. The identifiers identify the particular device, not the kind of device.",
"comments": "Often fixed to the device as a barcode. May include names given to the device in local usage. Note that some of the barcodes affixed to the device identify it's type, not it's instance.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
}
},
{
"path": "Device.type",
"definition": {
"short": "What kind of device this is",
"formal": "A kind of this device.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "DeviceKind",
"isExtensible": true,
"conformance": "example",
"referenceUri": "http://hit-testing.nist.gov:13110/rtmms/index.htm"
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
}
},
{
"path": "Device.manufacturer",
"definition": {
"short": "Name of device manufacturer",
"formal": "A name of the manufacturer.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".playedRole[typeCode=MANU].scoper.name"
}
]
}
},
{
"path": "Device.model",
"definition": {
"short": "Model id assigned by the manufacturer",
"formal": "The \"model\" - an identifier assigned by the manufacturer to identify the product by its type. This number is shared by the all devices sold as the same type.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".playedRole[typeCode=MANU].code"
}
]
}
},
{
"path": "Device.version",
"definition": {
"short": "Version number (i.e. software)",
"formal": "The version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".softwareName (included as part)"
}
]
}
},
{
"path": "Device.expiry",
"definition": {
"short": "Date of expiry of this device (if applicable)",
"formal": "Date of expiry of this device (if applicable).",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".expirationTime"
}
]
}
},
{
"path": "Device.udi",
"definition": {
"short": "FDA Mandated Unique Device Identifier",
"formal": "FDA Mandated Unique Device Identifier. Use the human readable information (the content that the user sees, which is sometimes different to the exact syntax represented in the barcode) - see http://www.fda.gov/MedicalDevices/DeviceRegulationandGuidance/UniqueDeviceIdentification/default.htm.",
"comments": "The unique identifier may identify an instance of a device uniquely, or it may just identify the type of the device. A portion of the UDI - the DI part - can be extracted from the UDI when required, and used to look up information about the device through the GUDID.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id[where root is root for UDI]"
}
]
}
},
{
"path": "Device.lotNumber",
"definition": {
"short": "Lot number of manufacture",
"formal": "Lot number assigned by the manufacturer.",
"comments": "Alphanumeric Maximum 20.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".lotNumberText"
}
]
}
},
{
"path": "Device.owner",
"definition": {
"short": "Organization responsible for device",
"formal": "An organization that is responsible for the provision and ongoing maintenance of the device.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".playedRole[typeCode=OWN].scoper"
}
]
}
},
{
"path": "Device.location",
"definition": {
"short": "Where the resource is found",
"formal": "The resource may be found in a literal location (i.e. GPS coordinates), a logical place (i.e. \"in/with the patient\"), or a coded location.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Location"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".playedRole[typeCode=LOCE].scoper"
}
]
}
},
{
"path": "Device.patient",
"definition": {
"short": "If the resource is affixed to a person",
"formal": "Patient information, if the resource is affixed to a person.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".playedRole[typeCode=USED].scoper.playedRole[typeCode=PAT]"
}
]
}
},
{
"path": "Device.contact",
"definition": {
"short": "Details for human/organization for support",
"formal": "Contact details for an organization or a particular human that is responsible for the device.",
"comments": "used for troubleshooting etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "Contact"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".scopedRole[typeCode=CON].player"
}
]
}
},
{
"path": "Device.url",
"definition": {
"short": "Network address to contact device",
"formal": "A network address on which the device may be contacted directly.",
"comments": "If the device is running a FHIR server, the network address should be the root URL from which a conformance statement may be retrieved.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".telecom"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "identifier",
"type": "token",
"documentation": "Instance id from manufacturer, owner and others",
"xpath": "f:Device/f:identifier"
},
{
"name": "location",
"type": "reference",
"documentation": "A location, where the resource is found",
"xpath": "f:Device/f:location"
},
{
"name": "manufacturer",
"type": "string",
"documentation": "The manufacturer of the device",
"xpath": "f:Device/f:manufacturer"
},
{
"name": "model",
"type": "string",
"documentation": "The model of the device",
"xpath": "f:Device/f:model"
},
{
"name": "organization",
"type": "reference",
"documentation": "The organization responsible for the device",
"xpath": "f:Device/f:owner"
},
{
"name": "patient",
"type": "reference",
"documentation": "Patient information, if the resource is affixed to a person",
"xpath": "f:Device/f:patient"
},
{
"name": "type",
"type": "token",
"documentation": "The type of the device",
"xpath": "f:Device/f:type"
},
{
"name": "udi",
"type": "string",
"documentation": "FDA Mandated Unique Device Identifier",
"xpath": "f:Device/f:udi"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"This resource identifies an instance of a manufactured thing that is used in the provision of healthcare without being substantially changed through that activity. The device may be a machine, an insert, a computer, an application, etc. This includes durable (reusable) medical equipment as well as disposable equipment used for diagnostic, treatment, and research for healthcare and public health.\" class=\"dict\" href=\"device-definitions.html#Device\"><b>Device</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Identifiers assigned to this device by various organizations. The most likely organizations to assign identifiers are the manufacturer and the owner, though regulatory agencies may also assign an identifier. The identifiers identify the particular device, not the kind of device.\" class=\"dict\" href=\"device-definitions.html#Device.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Instance id from manufacturer, owner and others</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"A kind of this device.\" class=\"dict\" href=\"device-definitions.html#Device.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://hit-testing.nist.gov:13110/rtmms/index.htm.html\">What kind of device this is</a></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"A name of the manufacturer.\" class=\"dict\" href=\"device-definitions.html#Device.manufacturer\"><b>manufacturer</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Name of device manufacturer</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The "model" - an identifier assigned by the manufacturer to identify the product by its type. This number is shared by the all devices sold as the same type.\" class=\"dict\" href=\"device-definitions.html#Device.model\"><b>model</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Model id assigned by the manufacturer</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware.\" class=\"dict\" href=\"device-definitions.html#Device.version\"><b>version</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Version number (i.e. software)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Date of expiry of this device (if applicable).\" class=\"dict\" href=\"device-definitions.html#Device.expiry\"><b>expiry</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#date\">date</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Date of expiry of this device (if applicable)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"FDA Mandated Unique Device Identifier. Use the human readable information (the content that the user sees, which is sometimes different to the exact syntax represented in the barcode) - see http://www.fda.gov/MedicalDevices/DeviceRegulationandGuidance/UniqueDeviceIdentification/default.htm.\" class=\"dict\" href=\"device-definitions.html#Device.udi\"><b>udi</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">FDA Mandated Unique Device Identifier</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Lot number assigned by the manufacturer.\" class=\"dict\" href=\"device-definitions.html#Device.lotNumber\"><b>lotNumber</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Lot number of manufacture</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"An organization that is responsible for the provision and ongoing maintenance of the device.\" class=\"dict\" href=\"device-definitions.html#Device.owner\"><b>owner</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">Organization responsible for device</span><span style=\"color: Gray\"> --></span></owner>\r\n <<a title=\"The resource may be found in a literal location (i.e. GPS coordinates), a logical place (i.e. "in/with the patient"), or a coded location.\" class=\"dict\" href=\"device-definitions.html#Device.location\"><b>location</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">Where the resource is found</span><span style=\"color: Gray\"> --></span></location>\r\n <<a title=\"Patient information, if the resource is affixed to a person.\" class=\"dict\" href=\"device-definitions.html#Device.patient\"><b>patient</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">If the resource is affixed to a person</span><span style=\"color: Gray\"> --></span></patient>\r\n <<a title=\"Contact details for an organization or a particular human that is responsible for the device.\" class=\"dict\" href=\"device-definitions.html#Device.contact\"><b>contact</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">Details for human/organization for support</span><span style=\"color: Gray\"> --></span></contact>\r\n <<a title=\"A network address on which the device may be contacted directly.\" class=\"dict\" href=\"device-definitions.html#Device.url\"><b>url</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Network address to contact device</span><span style=\"color: Gray\"> --></span>\r\n</Device>\r\n</pre></div>"
},
{
"title": "\"deviceobservationreport\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/deviceobservationreport",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/deviceobservationreport.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"Describes the data produced by a device at a point in time.\" class=\"dict\" href=\"deviceobservationreport-definitions.html#DeviceObservationReport\"><b>DeviceObservationReport</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"The point in time that the values are reported.\" class=\"dict\" href=\"deviceobservationreport-definitions.html#DeviceObservationReport.instant\"><b>instant</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#instant\">instant</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">When the data values are reported</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"An identifier assigned to this observation bu the source device that made the observation.\" class=\"dict\" href=\"deviceobservationreport-definitions.html#DeviceObservationReport.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">As assigned by the source device</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Identification information for the device that is the source of the data.\" class=\"dict\" href=\"deviceobservationreport-definitions.html#DeviceObservationReport.source\"><b>source</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"device.html#Device\">Device</a>)</span> <span style=\"color: navy\">Identifies/describes where the data came from</span><span style=\"color: Gray\"> --></span></source>\r\n <<a title=\"The subject of the measurement.\" class=\"dict\" href=\"deviceobservationreport-definitions.html#DeviceObservationReport.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"device.html#Device\">Device</a>|<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">Subject of the measurement</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"A medical-related subsystem of a medical device.\" class=\"dict\" href=\"deviceobservationreport-definitions.html#DeviceObservationReport.virtualDevice\"><b>virtualDevice</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> A medical-related subsystem of a medical device --></span>\r\n <<a title=\"Describes the compartment.\" class=\"dict\" href=\"deviceobservationreport-definitions.html#DeviceObservationReport.virtualDevice.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://hit-testing.nist.gov:13110/rtmms/index.htm.html\">Describes the compartment</a></span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"Groups together physiological measurement data and derived data.\" class=\"dict\" href=\"deviceobservationreport-definitions.html#DeviceObservationReport.virtualDevice.channel\"><b>channel</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Groups related data items --></span>\r\n <<a title=\"Describes the channel.\" class=\"dict\" href=\"deviceobservationreport-definitions.html#DeviceObservationReport.virtualDevice.channel.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://hit-testing.nist.gov:13110/rtmms/index.htm.html\">Describes the channel</a></span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"A piece of measured or derived data that is reported by the machine.\" class=\"dict\" href=\"deviceobservationreport-definitions.html#DeviceObservationReport.virtualDevice.channel.metric\"><b>metric</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Piece of data reported by device --></span>\r\n <<a title=\"The data for the metric.\" class=\"dict\" href=\"deviceobservationreport-definitions.html#DeviceObservationReport.virtualDevice.channel.metric.observation\"><b>observation</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"observation.html#Observation\">Observation</a>)</span> <span style=\"color: navy\">The data for the metric</span><span style=\"color: Gray\"> --></span></observation>\r\n </metric>\r\n </channel>\r\n </virtualDevice>\r\n</DeviceObservationReport>\r\n</pre></div>"
},
"name": "deviceobservationreport",
"publisher": "FHIR Project",
"description": "Basic Profile. Describes the data produced by a device at a point in time.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage This resource carries a set of data from a device that is observing a subject. Most commonly, the subject is a patient, and the device is something like a vital signs monitor, or a glucose measurement device, but other kinds of subjects and devices are expected as well. \r\n\r\nThis resource does not cater for: \r\n\r\n* Supporting real-time analytics and in particular, alarms that might be raised as a result of such analysis\r\n* Sending commands to a device\r\nThis capability is expected to be subject of additional resources that are yet to be developed, and implmenter input on this is welcome.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"structure": [
{
"type": "DeviceObservationReport",
"publish": true,
"element": [
{
"path": "DeviceObservationReport",
"definition": {
"short": "Describes the data produced by a device at a point in time",
"formal": "Describes the data produced by a device at a point in time.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Observation[classCode=OBS, moodCode=EVN, code < DeviceObservation]"
}
]
}
},
{
"path": "DeviceObservationReport.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DeviceObservationReport.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DeviceObservationReport.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "DeviceObservationReport.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "DeviceObservationReport.instant",
"definition": {
"short": "When the data values are reported",
"formal": "The point in time that the values are reported.",
"min": 1,
"max": "1",
"type": [
{
"code": "instant"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
}
},
{
"path": "DeviceObservationReport.identifier",
"definition": {
"short": "As assigned by the source device",
"formal": "An identifier assigned to this observation bu the source device that made the observation.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
}
},
{
"path": "DeviceObservationReport.source",
"definition": {
"short": "Identifies/describes where the data came from",
"formal": "Identification information for the device that is the source of the data.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PFM].role[player.classCode=DEV]"
}
]
}
},
{
"path": "DeviceObservationReport.subject",
"definition": {
"short": "Subject of the measurement",
"formal": "The subject of the measurement.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Location"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
}
]
}
},
{
"path": "DeviceObservationReport.virtualDevice",
"definition": {
"short": "A medical-related subsystem of a medical device",
"formal": "A medical-related subsystem of a medical device.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode='COMP'].target[classCode=OBS, moodCode=EVN, code < \"virtual device compartment\"]"
}
]
}
},
{
"path": "DeviceObservationReport.virtualDevice.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DeviceObservationReport.virtualDevice.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DeviceObservationReport.virtualDevice.code",
"definition": {
"short": "Describes the compartment",
"formal": "Describes the compartment.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "VirtalDeviceKind",
"isExtensible": true,
"conformance": "preferred",
"referenceUri": "http://hit-testing.nist.gov:13110/rtmms/index.htm"
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
}
},
{
"path": "DeviceObservationReport.virtualDevice.channel",
"definition": {
"short": "Groups related data items",
"formal": "Groups together physiological measurement data and derived data.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode='COMP'].target[classCode=OBS, moodCode=EVN, code < \"channel\"]"
}
]
}
},
{
"path": "DeviceObservationReport.virtualDevice.channel.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DeviceObservationReport.virtualDevice.channel.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DeviceObservationReport.virtualDevice.channel.code",
"definition": {
"short": "Describes the channel",
"formal": "Describes the channel.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "DeviceChannelKind1",
"isExtensible": true,
"conformance": "preferred",
"referenceUri": "http://hit-testing.nist.gov:13110/rtmms/index.htm"
},
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PFM].role.code"
}
]
}
},
{
"path": "DeviceObservationReport.virtualDevice.channel.metric",
"definition": {
"short": "Piece of data reported by device",
"formal": "A piece of measured or derived data that is reported by the machine.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
}
},
{
"path": "DeviceObservationReport.virtualDevice.channel.metric.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DeviceObservationReport.virtualDevice.channel.metric.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DeviceObservationReport.virtualDevice.channel.metric.observation",
"definition": {
"short": "The data for the metric",
"formal": "The data for the metric.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Observation"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".value"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "channel",
"type": "token",
"documentation": "The channel code",
"xpath": "f:DeviceObservationReport/f:virtualDevice/f:channel/f:code"
},
{
"name": "code",
"type": "token",
"documentation": "The compatment code",
"xpath": "f:DeviceObservationReport/f:virtualDevice/f:code"
},
{
"name": "observation",
"type": "reference",
"documentation": "The data for the metric",
"xpath": "f:DeviceObservationReport/f:virtualDevice/f:channel/f:metric/f:observation"
},
{
"name": "source",
"type": "reference",
"documentation": "Identifies/describes where the data came from",
"xpath": "f:DeviceObservationReport/f:source"
},
{
"name": "subject",
"type": "reference",
"documentation": "Subject of the measurement",
"xpath": "f:DeviceObservationReport/f:subject"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"Describes the data produced by a device at a point in time.\" class=\"dict\" href=\"deviceobservationreport-definitions.html#DeviceObservationReport\"><b>DeviceObservationReport</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"The point in time that the values are reported.\" class=\"dict\" href=\"deviceobservationreport-definitions.html#DeviceObservationReport.instant\"><b>instant</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#instant\">instant</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">When the data values are reported</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"An identifier assigned to this observation bu the source device that made the observation.\" class=\"dict\" href=\"deviceobservationreport-definitions.html#DeviceObservationReport.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">As assigned by the source device</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Identification information for the device that is the source of the data.\" class=\"dict\" href=\"deviceobservationreport-definitions.html#DeviceObservationReport.source\"><b>source</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"device.html#Device\">Device</a>)</span> <span style=\"color: navy\">Identifies/describes where the data came from</span><span style=\"color: Gray\"> --></span></source>\r\n <<a title=\"The subject of the measurement.\" class=\"dict\" href=\"deviceobservationreport-definitions.html#DeviceObservationReport.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"device.html#Device\">Device</a>|<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">Subject of the measurement</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"A medical-related subsystem of a medical device.\" class=\"dict\" href=\"deviceobservationreport-definitions.html#DeviceObservationReport.virtualDevice\"><b>virtualDevice</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> A medical-related subsystem of a medical device --></span>\r\n <<a title=\"Describes the compartment.\" class=\"dict\" href=\"deviceobservationreport-definitions.html#DeviceObservationReport.virtualDevice.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://hit-testing.nist.gov:13110/rtmms/index.htm.html\">Describes the compartment</a></span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"Groups together physiological measurement data and derived data.\" class=\"dict\" href=\"deviceobservationreport-definitions.html#DeviceObservationReport.virtualDevice.channel\"><b>channel</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Groups related data items --></span>\r\n <<a title=\"Describes the channel.\" class=\"dict\" href=\"deviceobservationreport-definitions.html#DeviceObservationReport.virtualDevice.channel.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://hit-testing.nist.gov:13110/rtmms/index.htm.html\">Describes the channel</a></span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"A piece of measured or derived data that is reported by the machine.\" class=\"dict\" href=\"deviceobservationreport-definitions.html#DeviceObservationReport.virtualDevice.channel.metric\"><b>metric</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Piece of data reported by device --></span>\r\n <<a title=\"The data for the metric.\" class=\"dict\" href=\"deviceobservationreport-definitions.html#DeviceObservationReport.virtualDevice.channel.metric.observation\"><b>observation</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"observation.html#Observation\">Observation</a>)</span> <span style=\"color: navy\">The data for the metric</span><span style=\"color: Gray\"> --></span></observation>\r\n </metric>\r\n </channel>\r\n </virtualDevice>\r\n</DeviceObservationReport>\r\n</pre></div>"
},
{
"title": "\"diagnosticorder\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/diagnosticorder",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/diagnosticorder.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"A request for a diagnostic investigation service to be performed.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder\"><b>DiagnosticOrder</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Who or what the investigation is to be performed on. This is usually a human patient, but diagnostic tests can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"group.html#Group\">Group</a>|<a href=\"location.html#Location\">Location</a>|<a href=\"device.html#Device\">Device</a>)</span> <span style=\"color: navy\">Who and/or what test is about</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"The practitioner that holds legal responsibility for ordering the investigation.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.orderer\"><b>orderer</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">Who ordered the test</span><span style=\"color: Gray\"> --></span></orderer>\r\n <<a title=\"Identifiers assigned to this order by the order or by the receiver.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Identifiers assigned to this order</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"An encounter that provides additional informaton about the healthcare context in which this request is made.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.encounter\"><b>encounter</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"encounter.html#Encounter\">Encounter</a>)</span> <span style=\"color: navy\">\r\n The encounter that this diagnostic order is associated with</span><span style=\"color: Gray\"> --></span></encounter>\r\n <<a title=\"An explanation or justification for why this diagnostic investigation is being requested.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.clinicalNotes\"><b>clinicalNotes</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Explanation/Justification for test</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"One or more specimens that the diagnostic investigation is about.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.specimen\"><b>specimen</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"specimen.html#Specimen\">Specimen</a>)</span> <span style=\"color: navy\">If the whole order relates to specific specimens</span><span style=\"color: Gray\"> --></span></specimen>\r\n <<a title=\"The status of the order.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.status\"><b>status</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"diagnostic-order-status.html\">requested | received | accepted | in progress | review | completed | suspended | rejected | failed</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The clinical priority associated with this order.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.priority\"><b>priority</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"diagnostic-order-priority.html\">routine | urgent | stat | asap</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A summary of the events of interest that have occurred as the request is processed. E.g. when the order was made, various processing steps (specimens received), when it was completed.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.event\"><b>event</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> A list of events of interest in the lifecycle --></span>\r\n <<a title=\"The status for the event.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.event.status\"><b>status</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"diagnostic-order-status.html\">requested | received | accepted | in progress | review | completed | suspended | rejected | failed</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Additional information about the event that occurred - e.g. if the status remained unchanged.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.event.description\"><b>description</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-diagnostic-order-event.html\">More information about the event and it's context</a></span><span style=\"color: Gray\"> --></span></description>\r\n <<a title=\"The date/time at which the event occurred.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.event.dateTime\"><b>dateTime</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">The date at which the event happened</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The person who was responsible for performing or recording the action.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.event.actor\"><b>actor</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"device.html#Device\">Device</a>)</span> <span style=\"color: navy\">Who recorded or did this</span><span style=\"color: Gray\"> --></span></actor>\r\n </event>\r\n <<a title=\"The specific diagnostic investigations that are requested as part of this request. Sometimes, there can only be one item per request, but in most contexts, more than one investigation can be requested.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.item\"><b>item</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> The items the orderer requested --></span>\r\n <<a title=\"A code that identifies a particular diagnostic investigation, or panel of investigations, that have been requested.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.item.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-diagnostic-requests.html\">Code to indicate the item (test or panel) being ordered</a></span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"If the item is related to a specific speciment.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.item.specimen\"><b>specimen</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"specimen.html#Specimen\">Specimen</a>)</span> <span style=\"color: navy\">If this item relates to specific specimens</span><span style=\"color: Gray\"> --></span></specimen>\r\n <<a title=\"Anatomical location where the request test should be performed.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.item.bodySite\"><b>bodySite</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-body-site.html\">Location of requested test (if applicable)</a></span><span style=\"color: Gray\"> --></span></bodySite>\r\n <<a title=\"The status of this individual item within the order.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.item.status\"><b>status</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"diagnostic-order-status.html\">requested | received | accepted | in progress | review | completed | suspended | rejected | failed</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A summary of the events of interest that have occurred as this item of the request is processed.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.item.event\"><b>event</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\">Content as for DiagnosticOrder.event</span> <span style=\"color: navy\">Events specific to this item</span><span style=\"color: Gray\"> --></span></event>\r\n </item>\r\n</DiagnosticOrder>\r\n</pre></div>"
},
"name": "diagnosticorder",
"publisher": "FHIR Project",
"description": "Basic Profile. A request for a diagnostic investigation service to be performed.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage A Diagnostic Order is a record of a request for a set of diagnostic investigations to be performed. The investigation will lead to a Diagnostic Report that summarizes the outcome of the investigation, and includes any useful data and/or images that are relevant to the treatment/management of the subject. \r\n\r\nThe principal intention of the Diagnostic Order is to support ordering diagnostic investigations on patients (which includes non-human patients in veterinary medicine). However in many contexts, healthcare related processes include performing diagnostic investigations on groups of subjects, devices involved in the provision of healthcare, and even environmental locations such as ducts, bodies of water, etc. The Diagnostic Order supports all these usages. \r\n\r\nThe general work flow that this resource facilitates is that a clinical system creates a diagnostic order. The diagnostic order is then exchanged, perhaps via intermediaries, with a system that represents a diagnostic service that can perform the investigation as a request to do so. The diagnostic service will update the request as the work is performed, and then finally issue a report that references the requests that it fulfills.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "DiagnosticOrder",
"publish": true,
"element": [
{
"path": "DiagnosticOrder",
"definition": {
"short": "A request for a diagnostic service",
"formal": "A request for a diagnostic investigation service to be performed.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Observation[classCode=OBS, moodCode=RQO, code<\"diagnostic order\"]"
}
]
}
},
{
"path": "DiagnosticOrder.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DiagnosticOrder.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DiagnosticOrder.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "DiagnosticOrder.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "DiagnosticOrder.subject",
"definition": {
"short": "Who and/or what test is about",
"formal": "Who or what the investigation is to be performed on. This is usually a human patient, but diagnostic tests can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Group"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Location"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
}
]
}
},
{
"path": "DiagnosticOrder.orderer",
"definition": {
"short": "Who ordered the test",
"formal": "The practitioner that holds legal responsibility for ordering the investigation.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
}
]
}
},
{
"path": "DiagnosticOrder.identifier",
"definition": {
"short": "Identifiers assigned to this order",
"formal": "Identifiers assigned to this order by the order or by the receiver.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
}
},
{
"path": "DiagnosticOrder.encounter",
"definition": {
"short": "The encounter that this diagnostic order is associated with",
"formal": "An encounter that provides additional informaton about the healthcare context in which this request is made.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Encounter"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"
}
]
}
},
{
"path": "DiagnosticOrder.clinicalNotes",
"definition": {
"short": "Explanation/Justification for test",
"formal": "An explanation or justification for why this diagnostic investigation is being requested.",
"comments": "This may be used to decide how the diagnostic investigation will be performed, or even if it will be performed at all.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".reasonCode.originalText"
}
]
}
},
{
"path": "DiagnosticOrder.specimen",
"definition": {
"short": "If the whole order relates to specific specimens",
"formal": "One or more specimens that the diagnostic investigation is about.",
"comments": "Many investigation requests will create a need for specimens, but the request itself is not actually about the specimens. This is provided for when the diagnostic investigation is requested on already existing specimens.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Specimen"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SPC].role"
}
]
}
},
{
"path": "DiagnosticOrder.status",
"definition": {
"short": "requested | received | accepted | in progress | review | completed | suspended | rejected | failed",
"formal": "The status of the order.",
"comments": "Typically the system placing the order sets the status to requested. There after, the order is maintained by the receiver that updates the status as the request is handled.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "DiagnosticOrderStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/diagnostic-order-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode\nalso influenced by whether a ControlAct fulfillment requeste exists, whether a promise exists, status of the review component, whether a fulfilling observation exists, whether a refusal exists"
}
]
}
},
{
"path": "DiagnosticOrder.priority",
"definition": {
"short": "routine | urgent | stat | asap",
"formal": "The clinical priority associated with this order.",
"comments": "The Order resource also has a priority. Generally, these should be the same, but they can be different, for instance in the case where the clinician indicates that the order is urgent, but the subsequent workflow process overrule this priority for some reason. The effective default value is \"normal\".",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "DiagnosticOrderPriority",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/diagnostic-order-priority"
}
},
"mapping": [
{
"identity": "rim",
"map": ".priorityCode"
}
]
}
},
{
"path": "DiagnosticOrder.event",
"definition": {
"short": "A list of events of interest in the lifecycle",
"formal": "A summary of the events of interest that have occurred as the request is processed. E.g. when the order was made, various processing steps (specimens received), when it was completed.",
"comments": "This is not the same as an audit trail - it is a view of the important things that happened in the past. Typically, there would only be one entry for any given status, and systems may not record all the status events.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=FLFS].source"
}
]
}
},
{
"path": "DiagnosticOrder.event.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DiagnosticOrder.event.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DiagnosticOrder.event.status",
"definition": {
"short": "requested | received | accepted | in progress | review | completed | suspended | rejected | failed",
"formal": "The status for the event.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "DiagnosticOrderStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/diagnostic-order-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode\nalso influenced by whether a ControlAct fulfillment requeste exists, whether a promise exists, status of the review component, whether a fulfilling observation exists, whether a refusal exists"
}
]
}
},
{
"path": "DiagnosticOrder.event.description",
"definition": {
"short": "More information about the event and it's context",
"formal": "Additional information about the event that occurred - e.g. if the status remained unchanged.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "DIagnosticOrderEventDescription",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/diagnostic-order-event"
}
},
"mapping": [
{
"identity": "rim",
"map": ".text"
}
]
}
},
{
"path": "DiagnosticOrder.event.dateTime",
"definition": {
"short": "The date at which the event happened",
"formal": "The date/time at which the event occurred.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
}
},
{
"path": "DiagnosticOrder.event.actor",
"definition": {
"short": "Who recorded or did this",
"formal": "The person who was responsible for performing or recording the action.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[AUT or PFM]"
}
]
}
},
{
"path": "DiagnosticOrder.item",
"definition": {
"short": "The items the orderer requested",
"formal": "The specific diagnostic investigations that are requested as part of this request. Sometimes, there can only be one item per request, but in most contexts, more than one investigation can be requested.",
"comments": "There would always be at least one item in normal usage, but this is optional so that a workflow can quote order details without having to list the items.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=OBS]"
}
]
}
},
{
"path": "DiagnosticOrder.item.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DiagnosticOrder.item.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DiagnosticOrder.item.code",
"definition": {
"short": "Code to indicate the item (test or panel) being ordered",
"formal": "A code that identifies a particular diagnostic investigation, or panel of investigations, that have been requested.",
"comments": "Many laboratory tests and radiology tests embed the specimen/organ system in the test name, for example, serum or serum/plasma glucose, or a chest xray. The specimen may not be recorded separately from the test code.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "DiagnosticRequests",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/diagnostic-requests"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "v2",
"map": "OBX-4"
}
]
}
},
{
"path": "DiagnosticOrder.item.specimen",
"definition": {
"short": "If this item relates to specific specimens",
"formal": "If the item is related to a specific speciment.",
"comments": "A single specimen should not appear in both DIagnosticOrder.specimen and DiagnosticOrder.item.specimen.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Specimen"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SPC].role"
}
]
}
},
{
"path": "DiagnosticOrder.item.bodySite",
"definition": {
"short": "Location of requested test (if applicable)",
"formal": "Anatomical location where the request test should be performed.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "BodySite",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/body-site"
}
},
"mapping": [
{
"identity": "rim",
"map": "targetSiteCode"
}
]
}
},
{
"path": "DiagnosticOrder.item.status",
"definition": {
"short": "requested | received | accepted | in progress | review | completed | suspended | rejected | failed",
"formal": "The status of this individual item within the order.",
"comments": "If the request has multiple items that have their own life cycles, then the items will have their own status while the overall diagnostic order is (usually) \"in progress\".",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "DiagnosticOrderStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/diagnostic-order-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode\nalso influenced by whether a ControlAct fulfillment requeste exists, whether a promise exists, status of the review component, whether a fulfilling observation exists, whether a refusal exists"
}
]
}
},
{
"path": "DiagnosticOrder.item.event",
"definition": {
"short": "Events specific to this item",
"formal": "A summary of the events of interest that have occurred as this item of the request is processed.",
"min": 0,
"max": "*",
"nameReference": "DiagnosticOrder.event",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=FLFS].source"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "actor",
"type": "reference",
"documentation": "Who recorded or did this"
},
{
"name": "bodysite",
"type": "token",
"documentation": "Location of requested test (if applicable)",
"xpath": "f:DiagnosticOrder/f:item/f:bodySite"
},
{
"name": "code",
"type": "token",
"documentation": "Code to indicate the item (test or panel) being ordered",
"xpath": "f:DiagnosticOrder/f:item/f:code"
},
{
"name": "encounter",
"type": "reference",
"documentation": "The encounter that this diagnostic order is associated with",
"xpath": "f:DiagnosticOrder/f:encounter"
},
{
"name": "event-date",
"type": "date",
"documentation": "The date at which the event happened",
"xpath": "f:DiagnosticOrder/f:event/f:dateTime"
},
{
"name": "event-status",
"type": "token",
"documentation": "requested | received | accepted | in progress | review | completed | suspended | rejected | failed",
"xpath": "f:DiagnosticOrder/f:event/f:status"
},
{
"name": "event-status-date",
"type": "composite",
"documentation": "A combination of past-status and date"
},
{
"name": "identifier",
"type": "token",
"documentation": "Identifiers assigned to this order",
"xpath": "f:DiagnosticOrder/f:identifier"
},
{
"name": "item-date",
"type": "date",
"documentation": "The date at which the event happened",
"xpath": "f:DiagnosticOrder/f:item/f:event/f:dateTime"
},
{
"name": "item-past-status",
"type": "token",
"documentation": "requested | received | accepted | in progress | review | completed | suspended | rejected | failed",
"xpath": "f:DiagnosticOrder/f:item/f:event/f:status"
},
{
"name": "item-status",
"type": "token",
"documentation": "requested | received | accepted | in progress | review | completed | suspended | rejected | failed",
"xpath": "f:DiagnosticOrder/f:item/f:status"
},
{
"name": "item-status-date",
"type": "composite",
"documentation": "A combination of item-past-status and item-date"
},
{
"name": "orderer",
"type": "reference",
"documentation": "Who ordered the test",
"xpath": "f:DiagnosticOrder/f:orderer"
},
{
"name": "specimen",
"type": "reference",
"documentation": "If the whole order relates to specific specimens"
},
{
"name": "status",
"type": "token",
"documentation": "requested | received | accepted | in progress | review | completed | suspended | rejected | failed",
"xpath": "f:DiagnosticOrder/f:status"
},
{
"name": "subject",
"type": "reference",
"documentation": "Who and/or what test is about",
"xpath": "f:DiagnosticOrder/f:subject"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"A request for a diagnostic investigation service to be performed.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder\"><b>DiagnosticOrder</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Who or what the investigation is to be performed on. This is usually a human patient, but diagnostic tests can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"group.html#Group\">Group</a>|<a href=\"location.html#Location\">Location</a>|<a href=\"device.html#Device\">Device</a>)</span> <span style=\"color: navy\">Who and/or what test is about</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"The practitioner that holds legal responsibility for ordering the investigation.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.orderer\"><b>orderer</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">Who ordered the test</span><span style=\"color: Gray\"> --></span></orderer>\r\n <<a title=\"Identifiers assigned to this order by the order or by the receiver.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Identifiers assigned to this order</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"An encounter that provides additional informaton about the healthcare context in which this request is made.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.encounter\"><b>encounter</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"encounter.html#Encounter\">Encounter</a>)</span> <span style=\"color: navy\">\r\n The encounter that this diagnostic order is associated with</span><span style=\"color: Gray\"> --></span></encounter>\r\n <<a title=\"An explanation or justification for why this diagnostic investigation is being requested.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.clinicalNotes\"><b>clinicalNotes</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Explanation/Justification for test</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"One or more specimens that the diagnostic investigation is about.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.specimen\"><b>specimen</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"specimen.html#Specimen\">Specimen</a>)</span> <span style=\"color: navy\">If the whole order relates to specific specimens</span><span style=\"color: Gray\"> --></span></specimen>\r\n <<a title=\"The status of the order.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.status\"><b>status</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"diagnostic-order-status.html\">requested | received | accepted | in progress | review | completed | suspended | rejected | failed</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The clinical priority associated with this order.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.priority\"><b>priority</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"diagnostic-order-priority.html\">routine | urgent | stat | asap</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A summary of the events of interest that have occurred as the request is processed. E.g. when the order was made, various processing steps (specimens received), when it was completed.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.event\"><b>event</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> A list of events of interest in the lifecycle --></span>\r\n <<a title=\"The status for the event.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.event.status\"><b>status</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"diagnostic-order-status.html\">requested | received | accepted | in progress | review | completed | suspended | rejected | failed</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Additional information about the event that occurred - e.g. if the status remained unchanged.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.event.description\"><b>description</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-diagnostic-order-event.html\">More information about the event and it's context</a></span><span style=\"color: Gray\"> --></span></description>\r\n <<a title=\"The date/time at which the event occurred.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.event.dateTime\"><b>dateTime</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">The date at which the event happened</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The person who was responsible for performing or recording the action.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.event.actor\"><b>actor</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"device.html#Device\">Device</a>)</span> <span style=\"color: navy\">Who recorded or did this</span><span style=\"color: Gray\"> --></span></actor>\r\n </event>\r\n <<a title=\"The specific diagnostic investigations that are requested as part of this request. Sometimes, there can only be one item per request, but in most contexts, more than one investigation can be requested.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.item\"><b>item</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> The items the orderer requested --></span>\r\n <<a title=\"A code that identifies a particular diagnostic investigation, or panel of investigations, that have been requested.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.item.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-diagnostic-requests.html\">Code to indicate the item (test or panel) being ordered</a></span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"If the item is related to a specific speciment.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.item.specimen\"><b>specimen</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"specimen.html#Specimen\">Specimen</a>)</span> <span style=\"color: navy\">If this item relates to specific specimens</span><span style=\"color: Gray\"> --></span></specimen>\r\n <<a title=\"Anatomical location where the request test should be performed.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.item.bodySite\"><b>bodySite</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-body-site.html\">Location of requested test (if applicable)</a></span><span style=\"color: Gray\"> --></span></bodySite>\r\n <<a title=\"The status of this individual item within the order.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.item.status\"><b>status</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"diagnostic-order-status.html\">requested | received | accepted | in progress | review | completed | suspended | rejected | failed</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A summary of the events of interest that have occurred as this item of the request is processed.\" class=\"dict\" href=\"diagnosticorder-definitions.html#DiagnosticOrder.item.event\"><b>event</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\">Content as for DiagnosticOrder.event</span> <span style=\"color: navy\">Events specific to this item</span><span style=\"color: Gray\"> --></span></event>\r\n </item>\r\n</DiagnosticOrder>\r\n</pre></div>"
},
{
"title": "\"diagnosticreport\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/diagnosticreport",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/diagnosticreport.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretation, and formatted representation of diagnostic reports.\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport\"><b>DiagnosticReport</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"A code or name that describes this diagnostic report.\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.name\"><b>name</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-report-names.html\">Name/Code for this diagnostic report</a></span><span style=\"color: Gray\"> --></span></name>\r\n <<a title=\"The status of the diagnostic report as a whole (this element modifies the meaning of other elements)\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"diagnostic-report-status.html\">registered | partial | final | corrected +<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The date and/or time that this version of the report was released from the source diagnostic service.\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.issued\"><b>issued</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Date this version was released<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The subject of the report. Usually, but not always, this is a patient. However diagnostic services also perform analyses on specimens collected from a variety of other sources.\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"group.html#Group\">Group</a>|<a href=\"device.html#Device\">Device</a>|<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">\r\n The subject of the report, usually, but not always, the patient<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"The diagnostic service that is responsible for issuing the report.\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.performer\"><b>performer</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">Responsible Diagnostic Service<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></performer>\r\n <<a title=\"The local ID assigned to the report by the order filler, usually by the Information System of the diagnostic service provider.\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Id for external references to this report<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Details concerning a test requested.\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.requestDetail\"><b>requestDetail</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"diagnosticorder.html#DiagnosticOrder\">DiagnosticOrder</a>)</span> <span style=\"color: navy\">What was requested</span><span style=\"color: Gray\"> --></span></requestDetail>\r\n <<a title=\"The section of the diagnostic service that performs the examination e.g. biochemistry, hematology, MRI.\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.serviceCategory\"><b>serviceCategory</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-diagnostic-service-sections.html\">Biochemistry, Hematology etc.<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></serviceCategory>\r\n <<a title=\"The time or time-period the observed values are related to. This is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.diagnostic_x_\"><b>diagnostic[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a>|<a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">\r\n Physiologically Relevant time/time-period for report<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></diagnostic[x]>\r\n <<a title=\"Details about the specimens on which this Disagnostic report is based.\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.specimen\"><b>specimen</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"specimen.html#Specimen\">Specimen</a>)</span> <span style=\"color: navy\">Specimens this report is based on</span><span style=\"color: Gray\"> --></span></specimen>\r\n <<a title=\"Observations that are part of this diagnostic report. Observations can be simple name/value pairs (e.g. "atomic" results), or they can be grouping observations that include references to other members of the group (e.g. "panels").\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.result\"><b>result</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"observation.html#Observation\">Observation</a>)</span> <span style=\"color: navy\">Observations - simple, or complex nested groups</span><span style=\"color: Gray\"> --></span></result>\r\n <<a title=\"One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images.\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.imagingStudy\"><b>imagingStudy</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"imagingstudy.html#ImagingStudy\">ImagingStudy</a>)</span> <span style=\"color: navy\">\r\n Reference to full details of imaging associated with the diagnostic report</span><span style=\"color: Gray\"> --></span></imagingStudy>\r\n <<a title=\"A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.image\"><b>image</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Key images associated with this report<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span> --></span>\r\n <<a title=\"A comment about the image. Typically, this is used to provide an explanation for why the image is included, or to draw the viewer's attention to important features.\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.image.comment\"><b>comment</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Comment about the image (e.g. explanation)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Reference to the image source.\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.image.link\"><b>link</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"media.html#Media\">Media</a>)</span> <span style=\"color: navy\">Reference to the image source<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></link>\r\n </image>\r\n <<a title=\"Concise and clinically contextualized narrative interpretation of the diagnostic report.\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.conclusion\"><b>conclusion</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Clinical Interpretation of test results</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Codes for the conclusion.\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.codedDiagnosis\"><b>codedDiagnosis</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-clinical-findings.html\">Codes for the conclusion</a></span><span style=\"color: Gray\"> --></span></codedDiagnosis>\r\n <<a title=\"Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.presentedForm\"><b>presentedForm</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Attachment\">Attachment</a></span> <span style=\"color: navy\">Entire Report as issued</span><span style=\"color: Gray\"> --></span></presentedForm>\r\n</DiagnosticReport>\r\n</pre></div>"
},
"name": "diagnosticreport",
"publisher": "FHIR Project",
"description": "Basic Profile. The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretation, and formatted representation of diagnostic reports.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage A diagnostic report is the set of information that is typically provided by a diagnostic service when investigations are complete. The information includes a mix of atomic results, text reports, images, and codes. The mix varies depending on the nature of the diagnostic procedure, and sometimes on the nature of the outcomes for a particular investigation. \r\n\r\nThe Diagnostic Report Resource is suitable for the following kinds of Diagnostic Reports: \r\n\r\n* Laboratory (Clinical Chemistry, Hematology, Microbiology, etc.)\r\n* Pathology / Histopathology / related disciplines\r\n* Imaging Investigations (x-ray, CT, MRI etc.)\r\n* Other diagnostics - Cardiology, Gastroenterology etc.\r\nThe Diagnostic Report resource is not intended to support cumulative result presentation (tabular presentation of past and present results in the resource). The Diagnostic Report resource does not yet provide full support for detailed structured reports of sequencing; this is planned for a future release.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "DiagnosticReport",
"publish": true,
"element": [
{
"path": "DiagnosticReport",
"definition": {
"short": "A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports",
"formal": "The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretation, and formatted representation of diagnostic reports.",
"comments": "This is intended to capture a single report,and is not suitable for use in displaying summary information that covers multiple reports. For example, this resource has not been designed for laboratory cumulative reporting formats nor detailed structured reports for sequencing.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Observation[classCode=OBS, moodCode=EVN]"
}
]
}
},
{
"path": "DiagnosticReport.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DiagnosticReport.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DiagnosticReport.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "DiagnosticReport.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "DiagnosticReport.name",
"definition": {
"short": "Name/Code for this diagnostic report",
"formal": "A code or name that describes this diagnostic report.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "DiagnosticReportNames",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/report-names"
}
},
"mapping": [
{
"identity": "rim",
"map": "code"
},
{
"identity": "v2",
"map": "OBR-4-Universal Service ID (V2 doesn't provide an easy way to indicate both the ordered test and the performed panel)"
}
]
}
},
{
"path": "DiagnosticReport.status",
"definition": {
"short": "registered | partial | final | corrected +",
"formal": "The status of the diagnostic report as a whole.",
"comments": "This is labeled as \"Is Modifier\" because applications need to take appropriate action if a report is withdrawn.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "DiagnosticReportStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/diagnostic-report-status"
}
},
"mapping": [
{
"identity": "rim",
"map": "statusCode\n\nNote: final and amended are distinguished by whether observation is the subject of a ControlAct event of type \"revise\""
},
{
"identity": "v2",
"map": "OBR-25-Result Status (not 1:1 mapping)"
}
]
}
},
{
"path": "DiagnosticReport.issued",
"definition": {
"short": "Date this version was released",
"formal": "The date and/or time that this version of the report was released from the source diagnostic service.",
"comments": "May be different from the update time of the resource itself, because that is the status of the record (potentially a secondary copy), not the actual release time of the report.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "participation[typeCode=VRF or AUT].time"
},
{
"identity": "v2",
"map": "OBR-22-Results Rpt/Status Chng - Date/Time"
}
]
}
},
{
"path": "DiagnosticReport.subject",
"definition": {
"short": "The subject of the report, usually, but not always, the patient",
"formal": "The subject of the report. Usually, but not always, this is a patient. However diagnostic services also perform analyses on specimens collected from a variety of other sources.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Group"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Location"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "participation[typeCode=SBJ]"
},
{
"identity": "v2",
"map": "PID-3-Patient ID List (no V2 mapping for Group or Device)"
}
]
}
},
{
"path": "DiagnosticReport.performer",
"definition": {
"short": "Responsible Diagnostic Service",
"formal": "The diagnostic service that is responsible for issuing the report.",
"comments": "This is not necessarily the source of the atomic data items - it is the entity that takes responsibility for the clinical report.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "participation[typeCode=AUT].role[classCode=ASSIGN].scoper"
},
{
"identity": "v2",
"map": "PRT-8-Participation Organization (where this PRT-4-Participation = \"PO\")"
}
]
}
},
{
"path": "DiagnosticReport.identifier",
"definition": {
"short": "Id for external references to this report",
"formal": "The local ID assigned to the report by the order filler, usually by the Information System of the diagnostic service provider.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "id"
},
{
"identity": "v2",
"map": "OBR-51-Observation Group ID (todo: check semantic intent of OBR-51 with OOWG)"
}
]
}
},
{
"path": "DiagnosticReport.requestDetail",
"definition": {
"short": "What was requested",
"formal": "Details concerning a test requested.",
"comments": "Note: Usually there is one test request for each result, however in some circumstances multiple test requests may be represented using a single test result resource. Note that there are also cases where one request leads to multiple reports.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/DiagnosticOrder"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=FLFS].target"
}
]
}
},
{
"path": "DiagnosticReport.serviceCategory",
"definition": {
"short": "Biochemistry, Hematology etc.",
"formal": "The section of the diagnostic service that performs the examination e.g. biochemistry, hematology, MRI.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "DiagnosticServiceSection",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/diagnostic-service-sections"
}
},
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=COMP].source[classCode=LIST, moodCode=EVN, code < LabService].code"
},
{
"identity": "v2",
"map": "OBR-24-Diagnostic Service Section ID"
}
]
}
},
{
"path": "DiagnosticReport.diagnostic[x]",
"definition": {
"short": "Physiologically Relevant time/time-period for report",
"formal": "The time or time-period the observed values are related to. This is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.",
"comments": "If the diagnostic procedure was performed on the patient, this is the time it was performed. If there are specimens, the diagnostically relevant time can be derived from the specimen collection times, but the specimen information is not always available, and the exact relationship between the specimens and the diagnostically relevant time is not always automatic.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "effectiveTime"
},
{
"identity": "v2",
"map": "OBR-7-Observation Date/Time"
}
]
}
},
{
"path": "DiagnosticReport.specimen",
"definition": {
"short": "Specimens this report is based on",
"formal": "Details about the specimens on which this Disagnostic report is based.",
"comments": "If the specimen is sufficiently specified with a code in the Test result name, then this additional data may be redundant. If there are multiple specimens, these may be represented per Observation or group.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Specimen"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "participation[typeCode=SBJ]"
},
{
"identity": "v2",
"map": "SPM"
}
]
}
},
{
"path": "DiagnosticReport.result",
"definition": {
"short": "Observations - simple, or complex nested groups",
"formal": "Observations that are part of this diagnostic report. Observations can be simple name/value pairs (e.g. \"atomic\" results), or they can be grouping observations that include references to other members of the group (e.g. \"panels\").",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Observation"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=COMP].target"
}
]
}
},
{
"path": "DiagnosticReport.imagingStudy",
"definition": {
"short": "Reference to full details of imaging associated with the diagnostic report",
"formal": "One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images.",
"comments": "ImagingStudy and image are somewhat overlapping - typically, an image in the image list will also be found in the imaging study resource. However the imaging study and image lists cater to different types of displays for different types of purposes. Neither, either, or both may be provided.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/ImagingStudy"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=COMP].target[classsCode=DGIMG, moodCode=EVN]"
}
]
}
},
{
"path": "DiagnosticReport.image",
"definition": {
"short": "Key images associated with this report",
"formal": "A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=COMP].target"
},
{
"identity": "v2",
"map": "OBX?"
}
]
}
},
{
"path": "DiagnosticReport.image.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DiagnosticReport.image.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DiagnosticReport.image.comment",
"definition": {
"short": "Comment about the image (e.g. explanation)",
"formal": "A comment about the image. Typically, this is used to provide an explanation for why the image is included, or to draw the viewer's attention to important features.",
"comments": "The comment should be displayed with the image. It would be common for the report to include additional discussion of the image contents in other sections such as the conclusion.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}
]
}
},
{
"path": "DiagnosticReport.image.link",
"definition": {
"short": "Reference to the image source",
"formal": "Reference to the image source.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Media"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".value.reference"
}
]
}
},
{
"path": "DiagnosticReport.conclusion",
"definition": {
"short": "Clinical Interpretation of test results",
"formal": "Concise and clinically contextualized narrative interpretation of the diagnostic report.",
"comments": "Typically, a report is either [all data, no narrative (e.g. Core lab)] or [a mix of data with some concluding narrative (e.g. Structured Pathology Report, Bone Density)], or [all narrative (e.g. typical imaging report, histopathology)]. In all of these cases, the narrative goes in \"text\".",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=\"SPRT\"].source[classCode=OBS, moodCode=EVN, code=LOINC:48767-8].value (type=ST)"
},
{
"identity": "v2",
"map": "OBX"
}
]
}
},
{
"path": "DiagnosticReport.codedDiagnosis",
"definition": {
"short": "Codes for the conclusion",
"formal": "Codes for the conclusion.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "AdjunctDiagnosis",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/clinical-findings"
}
},
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SPRT].source[classCode=OBS, moodCode=EVN, code=LOINC:54531-9].value (type=CD)"
},
{
"identity": "v2",
"map": "OBX"
}
]
}
},
{
"path": "DiagnosticReport.presentedForm",
"definition": {
"short": "Entire Report as issued",
"formal": "Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.",
"comments": "Application/pdf is recommended as the most reliable and interoperable in this context.",
"min": 0,
"max": "*",
"type": [
{
"code": "Attachment"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "text (type=ED)"
},
{
"identity": "v2",
"map": "OBX"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "date",
"type": "date",
"documentation": "The clinically relevant time of the report",
"xpath": "f:DiagnosticReport/f:diagnostic[x]"
},
{
"name": "diagnosis",
"type": "token",
"documentation": "A coded diagnosis on the report",
"xpath": "f:DiagnosticReport/f:codedDiagnosis"
},
{
"name": "identifier",
"type": "token",
"documentation": "An identifier for the report",
"xpath": "f:DiagnosticReport/f:identifier"
},
{
"name": "image",
"type": "reference",
"documentation": "Reference to the image source",
"xpath": "f:DiagnosticReport/f:image/f:link"
},
{
"name": "issued",
"type": "date",
"documentation": "When the report was issued",
"xpath": "f:DiagnosticReport/f:issued"
},
{
"name": "name",
"type": "token",
"documentation": "The name of the report (e.g. the code for the report as a whole, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result)",
"xpath": "f:DiagnosticReport/f:name"
},
{
"name": "performer",
"type": "reference",
"documentation": "Who was the source of the report (organization)",
"xpath": "f:DiagnosticReport/f:performer"
},
{
"name": "request",
"type": "reference",
"documentation": "What was requested",
"xpath": "f:DiagnosticReport/f:requestDetail"
},
{
"name": "result",
"type": "reference",
"documentation": "Link to an atomic result (observation resource)",
"xpath": "f:DiagnosticReport/f:result"
},
{
"name": "service",
"type": "token",
"documentation": "Which diagnostic discipline/department created the report",
"xpath": "f:DiagnosticReport/f:serviceCategory"
},
{
"name": "specimen",
"type": "reference",
"documentation": "The specimen details",
"xpath": "f:DiagnosticReport/f:specimen"
},
{
"name": "status",
"type": "token",
"documentation": "The status of the report",
"xpath": "f:DiagnosticReport/f:status"
},
{
"name": "subject",
"type": "reference",
"documentation": "The subject of the report",
"xpath": "f:DiagnosticReport/f:subject"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretation, and formatted representation of diagnostic reports.\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport\"><b>DiagnosticReport</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"A code or name that describes this diagnostic report.\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.name\"><b>name</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-report-names.html\">Name/Code for this diagnostic report</a></span><span style=\"color: Gray\"> --></span></name>\r\n <<a title=\"The status of the diagnostic report as a whole (this element modifies the meaning of other elements)\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"diagnostic-report-status.html\">registered | partial | final | corrected +<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The date and/or time that this version of the report was released from the source diagnostic service.\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.issued\"><b>issued</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Date this version was released<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The subject of the report. Usually, but not always, this is a patient. However diagnostic services also perform analyses on specimens collected from a variety of other sources.\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"group.html#Group\">Group</a>|<a href=\"device.html#Device\">Device</a>|<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">\r\n The subject of the report, usually, but not always, the patient<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"The diagnostic service that is responsible for issuing the report.\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.performer\"><b>performer</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">Responsible Diagnostic Service<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></performer>\r\n <<a title=\"The local ID assigned to the report by the order filler, usually by the Information System of the diagnostic service provider.\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Id for external references to this report<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Details concerning a test requested.\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.requestDetail\"><b>requestDetail</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"diagnosticorder.html#DiagnosticOrder\">DiagnosticOrder</a>)</span> <span style=\"color: navy\">What was requested</span><span style=\"color: Gray\"> --></span></requestDetail>\r\n <<a title=\"The section of the diagnostic service that performs the examination e.g. biochemistry, hematology, MRI.\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.serviceCategory\"><b>serviceCategory</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-diagnostic-service-sections.html\">Biochemistry, Hematology etc.<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></serviceCategory>\r\n <<a title=\"The time or time-period the observed values are related to. This is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.diagnostic_x_\"><b>diagnostic[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a>|<a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">\r\n Physiologically Relevant time/time-period for report<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></diagnostic[x]>\r\n <<a title=\"Details about the specimens on which this Disagnostic report is based.\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.specimen\"><b>specimen</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"specimen.html#Specimen\">Specimen</a>)</span> <span style=\"color: navy\">Specimens this report is based on</span><span style=\"color: Gray\"> --></span></specimen>\r\n <<a title=\"Observations that are part of this diagnostic report. Observations can be simple name/value pairs (e.g. "atomic" results), or they can be grouping observations that include references to other members of the group (e.g. "panels").\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.result\"><b>result</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"observation.html#Observation\">Observation</a>)</span> <span style=\"color: navy\">Observations - simple, or complex nested groups</span><span style=\"color: Gray\"> --></span></result>\r\n <<a title=\"One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images.\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.imagingStudy\"><b>imagingStudy</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"imagingstudy.html#ImagingStudy\">ImagingStudy</a>)</span> <span style=\"color: navy\">\r\n Reference to full details of imaging associated with the diagnostic report</span><span style=\"color: Gray\"> --></span></imagingStudy>\r\n <<a title=\"A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.image\"><b>image</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Key images associated with this report<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span> --></span>\r\n <<a title=\"A comment about the image. Typically, this is used to provide an explanation for why the image is included, or to draw the viewer's attention to important features.\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.image.comment\"><b>comment</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Comment about the image (e.g. explanation)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Reference to the image source.\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.image.link\"><b>link</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"media.html#Media\">Media</a>)</span> <span style=\"color: navy\">Reference to the image source<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></link>\r\n </image>\r\n <<a title=\"Concise and clinically contextualized narrative interpretation of the diagnostic report.\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.conclusion\"><b>conclusion</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Clinical Interpretation of test results</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Codes for the conclusion.\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.codedDiagnosis\"><b>codedDiagnosis</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-clinical-findings.html\">Codes for the conclusion</a></span><span style=\"color: Gray\"> --></span></codedDiagnosis>\r\n <<a title=\"Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.\" class=\"dict\" href=\"diagnosticreport-definitions.html#DiagnosticReport.presentedForm\"><b>presentedForm</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Attachment\">Attachment</a></span> <span style=\"color: navy\">Entire Report as issued</span><span style=\"color: Gray\"> --></span></presentedForm>\r\n</DiagnosticReport>\r\n</pre></div>"
},
{
"title": "\"documentmanifest\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/documentmanifest",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/documentmanifest.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"A manifest that defines a set of documents.\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest\"><b>DocumentManifest</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.masterIdentifier\"><b>masterIdentifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Unique Identifier for the set of documents</span><span style=\"color: Gray\"> --></span></masterIdentifier>\r\n <<a title=\"Other identifiers associated with the document, including version independent, source record and workflow related identifiers.\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Other identifiers for the manifest</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Who or what the set of documents is about. The documents can be about a person, (patient or healthcare practitioner), a device (i.e. machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case).\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"group.html#Group\">Group</a>|<a href=\"device.html#Device\">Device</a>)</span> <span style=\"color: navy\">\r\n The subject of the set of documents</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"A patient, practitioner, or organization for which this set of documents is intended.\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.recipient\"><b>recipient</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">\r\n Intended to get notified about this set of documents</span><span style=\"color: Gray\"> --></span></recipient>\r\n <<a title=\"Specifies the kind of this set of documents (e.g. Patient Summary, Discharge Summary, Prescription, etc.). The type of a set of documents may be the same as one of the documents in it - especially if there is only one - but it may be wider.\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-docset-codes.html\">What kind of document set this is</a></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"Identifies who is responsible for adding the information to the document.\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.author\"><b>author</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"device.html#Device\">Device</a>|<a href=\"patient.html#Patient\">Patient</a>|<a href=\"relatedperson.html#RelatedPerson\">RelatedPerson</a>)</span> <span style=\"color: navy\">\r\n Who and/or what authored the document</span><span style=\"color: Gray\"> --></span></author>\r\n <<a title=\"When the document manifest was created for submission to the server (not necessarily the same thing as the actual resource last modified time, since it may be modified, replicated etc).\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.created\"><b>created</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When this document manifest created</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identifies the source system, application, or software that produced the document manifest.\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.source\"><b>source</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">The source system/application/software</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The status of this document manifest (this element modifies the meaning of other elements)\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"document-reference-status.html\">current | superceded | entered in error</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Whether this document manifest replaces another (this element modifies the meaning of other elements)\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.supercedes\"><span style=\"text-decoration: underline\"><b>supercedes</b></span></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"documentmanifest.html#DocumentManifest\">DocumentManifest</a>)</span> <span style=\"color: navy\">\r\n If this document manifest replaces another</span><span style=\"color: Gray\"> --></span></supercedes>\r\n <<a title=\"Human-readable description of the source document. This is sometimes known as the "title".\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Human-readable description (title)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A code specifying the level of confidentiality of this set of Documents (this element modifies the meaning of other elements)\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.confidentiality\"><span style=\"text-decoration: underline\"><b>confidentiality</b></span></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v3/vs/Confidentiality/index.html\">Sensitivity of set of documents</a><span style=\"color: Gray\"> --></span></confidentiality>\r\n <<a title=\"The list of resources that describe the parts of this document reference. Usually, these would be document references, but direct references to binary attachments and images are also allowed.\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.content\"><b>content</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"documentreference.html#DocumentReference\">DocumentReference</a>|<a href=\"extras.html#Binary\">Binary</a>|<a href=\"media.html#Media\">Media</a>)</span> <span style=\"color: navy\">\r\n Contents of this set of documents</span><span style=\"color: Gray\"> --></span></content>\r\n</DocumentManifest>\r\n</pre></div>"
},
"name": "documentmanifest",
"publisher": "FHIR Project",
"description": "Basic Profile. A manifest that defines a set of documents.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage A document manifest gathers a set of Document Reference resources into a single package that may be the subject of workflow such as access control, auditing, and targeted delivery. \r\n\r\nTypically, Document Manifest Resources are used in document indexing systems, such as IHE XDS (see the XDS specific profile).",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "DocumentManifest",
"publish": true,
"element": [
{
"path": "DocumentManifest",
"definition": {
"short": "A manifest that defines a set of documents",
"formal": "A manifest that defines a set of documents.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Act[classCode=FOLDER, moodCode=EVN]"
}
]
}
},
{
"path": "DocumentManifest.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DocumentManifest.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DocumentManifest.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "DocumentManifest.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "DocumentManifest.masterIdentifier",
"definition": {
"short": "Unique Identifier for the set of documents",
"formal": "A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.",
"min": 1,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "id [need a list semantic to indicate order matters]"
}
]
}
},
{
"path": "DocumentManifest.identifier",
"definition": {
"short": "Other identifiers for the manifest",
"formal": "Other identifiers associated with the document, including version independent, source record and workflow related identifiers.",
"comments": "Other identifiers can also include Identifiers may be Accession Numbers, Order Numbers, Referral Request \nIdentifiers, XDS Workflow Instance Identifiers.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id / .setId"
},
{
"identity": "v2",
"map": "TXA-16-Unique Document File Name?"
}
]
}
},
{
"path": "DocumentManifest.subject",
"definition": {
"short": "The subject of the set of documents",
"formal": "Who or what the set of documents is about. The documents can be about a person, (patient or healthcare practitioner), a device (i.e. machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case).",
"min": 1,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Group"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
}
]
}
},
{
"path": "DocumentManifest.recipient",
"definition": {
"short": "Intended to get notified about this set of documents",
"formal": "A patient, practitioner, or organization for which this set of documents is intended.",
"comments": "How the recipient receives the document set or is notified of it is up to the implementation. This element is just a statement of intent.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=IRCP].role"
}
]
}
},
{
"path": "DocumentManifest.type",
"definition": {
"short": "What kind of document set this is",
"formal": "Specifies the kind of this set of documents (e.g. Patient Summary, Discharge Summary, Prescription, etc.). The type of a set of documents may be the same as one of the documents in it - especially if there is only one - but it may be wider.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "DocumentSetType",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/docset-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
}
},
{
"path": "DocumentManifest.author",
"definition": {
"short": "Who and/or what authored the document",
"formal": "Identifies who is responsible for adding the information to the document.",
"comments": "Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant).",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/RelatedPerson"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
}
]
}
},
{
"path": "DocumentManifest.created",
"definition": {
"short": "When this document manifest created",
"formal": "When the document manifest was created for submission to the server (not necessarily the same thing as the actual resource last modified time, since it may be modified, replicated etc).",
"comments": "Creation time is used for tracking, organizing versions and searching. This is the creation time of the document set, not the documents on which it is based.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
}
]
}
},
{
"path": "DocumentManifest.source",
"definition": {
"short": "The source system/application/software",
"formal": "Identifies the source system, application, or software that produced the document manifest.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PFM].time"
}
]
}
},
{
"path": "DocumentManifest.status",
"definition": {
"short": "current | superceded | entered in error",
"formal": "The status of this document manifest.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "DocumentReferenceStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/document-reference-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode"
}
]
}
},
{
"path": "DocumentManifest.supercedes",
"definition": {
"short": "If this document manifest replaces another",
"formal": "Whether this document manifest replaces another.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/DocumentManifest"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RPLC].target"
}
]
}
},
{
"path": "DocumentManifest.description",
"definition": {
"short": "Human-readable description (title)",
"formal": "Human-readable description of the source document. This is sometimes known as the \"title\".",
"comments": "What the document is about, rather than a terse summary of the document. It is commonly the case that records do not have a title and are collectively referred to by the display name of Record code (e.g. a \"consultation\" or \"progress note\").",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".title"
}
]
}
},
{
"path": "DocumentManifest.confidentiality",
"definition": {
"short": "Sensitivity of set of documents",
"formal": "A code specifying the level of confidentiality of this set of Documents.",
"comments": "The document set is at least as confidential as the most confidential of the documents in it.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": true,
"binding": {
"name": "DocumentConfidentiality",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/v3/vs/Confidentiality"
}
},
"mapping": [
{
"identity": "rim",
"map": ".confidentialityCode"
}
]
}
},
{
"path": "DocumentManifest.content",
"definition": {
"short": "Contents of this set of documents",
"formal": "The list of resources that describe the parts of this document reference. Usually, these would be document references, but direct references to binary attachments and images are also allowed.",
"min": 1,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/DocumentReference"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Binary"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Media"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "author",
"type": "reference",
"documentation": "Who and/or what authored the document",
"xpath": "f:DocumentManifest/f:author"
},
{
"name": "confidentiality",
"type": "token",
"documentation": "Sensitivity of set of documents",
"xpath": "f:DocumentManifest/f:confidentiality"
},
{
"name": "content",
"type": "reference",
"documentation": "Contents of this set of documents",
"xpath": "f:DocumentManifest/f:content"
},
{
"name": "created",
"type": "date",
"documentation": "When this document manifest created",
"xpath": "f:DocumentManifest/f:created"
},
{
"name": "description",
"type": "string",
"documentation": "Human-readable description (title)",
"xpath": "f:DocumentManifest/f:description"
},
{
"name": "identifier",
"type": "token",
"documentation": "Unique Identifier for the set of documents"
},
{
"name": "recipient",
"type": "reference",
"documentation": "Intended to get notified about this set of documents",
"xpath": "f:DocumentManifest/f:recipient"
},
{
"name": "status",
"type": "token",
"documentation": "current | superceded | entered in error",
"xpath": "f:DocumentManifest/f:status"
},
{
"name": "subject",
"type": "reference",
"documentation": "The subject of the set of documents",
"xpath": "f:DocumentManifest/f:subject"
},
{
"name": "supersedes",
"type": "reference",
"documentation": "If this document manifest replaces another",
"xpath": "f:DocumentManifest/f:supercedes"
},
{
"name": "type",
"type": "token",
"documentation": "What kind of document set this is",
"xpath": "f:DocumentManifest/f:type"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"A manifest that defines a set of documents.\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest\"><b>DocumentManifest</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.masterIdentifier\"><b>masterIdentifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Unique Identifier for the set of documents</span><span style=\"color: Gray\"> --></span></masterIdentifier>\r\n <<a title=\"Other identifiers associated with the document, including version independent, source record and workflow related identifiers.\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Other identifiers for the manifest</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Who or what the set of documents is about. The documents can be about a person, (patient or healthcare practitioner), a device (i.e. machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case).\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"group.html#Group\">Group</a>|<a href=\"device.html#Device\">Device</a>)</span> <span style=\"color: navy\">\r\n The subject of the set of documents</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"A patient, practitioner, or organization for which this set of documents is intended.\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.recipient\"><b>recipient</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">\r\n Intended to get notified about this set of documents</span><span style=\"color: Gray\"> --></span></recipient>\r\n <<a title=\"Specifies the kind of this set of documents (e.g. Patient Summary, Discharge Summary, Prescription, etc.). The type of a set of documents may be the same as one of the documents in it - especially if there is only one - but it may be wider.\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-docset-codes.html\">What kind of document set this is</a></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"Identifies who is responsible for adding the information to the document.\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.author\"><b>author</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"device.html#Device\">Device</a>|<a href=\"patient.html#Patient\">Patient</a>|<a href=\"relatedperson.html#RelatedPerson\">RelatedPerson</a>)</span> <span style=\"color: navy\">\r\n Who and/or what authored the document</span><span style=\"color: Gray\"> --></span></author>\r\n <<a title=\"When the document manifest was created for submission to the server (not necessarily the same thing as the actual resource last modified time, since it may be modified, replicated etc).\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.created\"><b>created</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When this document manifest created</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identifies the source system, application, or software that produced the document manifest.\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.source\"><b>source</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">The source system/application/software</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The status of this document manifest (this element modifies the meaning of other elements)\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"document-reference-status.html\">current | superceded | entered in error</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Whether this document manifest replaces another (this element modifies the meaning of other elements)\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.supercedes\"><span style=\"text-decoration: underline\"><b>supercedes</b></span></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"documentmanifest.html#DocumentManifest\">DocumentManifest</a>)</span> <span style=\"color: navy\">\r\n If this document manifest replaces another</span><span style=\"color: Gray\"> --></span></supercedes>\r\n <<a title=\"Human-readable description of the source document. This is sometimes known as the "title".\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Human-readable description (title)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A code specifying the level of confidentiality of this set of Documents (this element modifies the meaning of other elements)\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.confidentiality\"><span style=\"text-decoration: underline\"><b>confidentiality</b></span></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v3/vs/Confidentiality/index.html\">Sensitivity of set of documents</a><span style=\"color: Gray\"> --></span></confidentiality>\r\n <<a title=\"The list of resources that describe the parts of this document reference. Usually, these would be document references, but direct references to binary attachments and images are also allowed.\" class=\"dict\" href=\"documentmanifest-definitions.html#DocumentManifest.content\"><b>content</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"documentreference.html#DocumentReference\">DocumentReference</a>|<a href=\"extras.html#Binary\">Binary</a>|<a href=\"media.html#Media\">Media</a>)</span> <span style=\"color: navy\">\r\n Contents of this set of documents</span><span style=\"color: Gray\"> --></span></content>\r\n</DocumentManifest>\r\n</pre></div>"
},
{
"title": "\"documentreference\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/documentreference",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/documentreference.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"A reference to a document.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference\"><b>DocumentReference</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.masterIdentifier\"><b>masterIdentifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Master Version Specific Identifier</span><span style=\"color: Gray\"> --></span></masterIdentifier>\r\n <<a title=\"Other identifiers associated with the document, including version independent, source record and workflow related identifiers.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Other identifiers for the document</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (I.e. machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"group.html#Group\">Group</a>|<a href=\"device.html#Device\">Device</a>)</span> <span style=\"color: navy\">\r\n Who|what is the subject of the document</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"Specifies the particular kind of document (e.g. Patient Summary, Discharge Summary, Prescription, etc.).\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-doc-codes.html\">What kind of document this is (LOINC if possible)</a></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"A categorization for the type of the document. This may be implied by or derived from the code specified in the Document Type.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.class\"><b>class</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-xds-typecodes.html\">Categorization of Document</a></span><span style=\"color: Gray\"> --></span></class>\r\n <<a title=\"Identifies who is responsible for adding the information to the document.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.author\"><b>author</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"device.html#Device\">Device</a>|<a href=\"patient.html#Patient\">Patient</a>|<a href=\"relatedperson.html#RelatedPerson\">RelatedPerson</a>)</span> <span style=\"color: navy\">\r\n Who and/or what authored the document</span><span style=\"color: Gray\"> --></span></author>\r\n <<a title=\"Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.custodian\"><b>custodian</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">Org which maintains the document</span><span style=\"color: Gray\"> --></span></custodian>\r\n <<a title=\"A reference to a domain or server that manages policies under which the document is accessed and/or made available.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.policyManager\"><b>policyManager</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Manages access policies for the document</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Which person or organization authenticates that this document is valid.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.authenticator\"><b>authenticator</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">\r\n Who/What authenticated the document</span><span style=\"color: Gray\"> --></span></authenticator>\r\n <<a title=\"When the document was created.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.created\"><b>created</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Document creation time</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"When the document reference was created.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.indexed\"><b>indexed</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#instant\">instant</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">When this document reference created</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The status of this document reference (this element modifies the meaning of other elements)\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"document-reference-status.html\">current | superceded | entered in error</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The status of the underlying document.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.docStatus\"><b>docStatus</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"composition-status.html\">preliminary | final | appended | amended | entered in error</a><span style=\"color: Gray\"> --></span></docStatus>\r\n <<a title=\"Relationships that this document has with other document references that already exist (this element modifies the meaning of other elements)\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.relatesTo\"><span style=\"text-decoration: underline\"><b>relatesTo</b></span></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Relationships to other documents --></span>\r\n <<a title=\"The type of relationship that this document has with anther document.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.relatesTo.code\"><b>code</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"document-relationship-type.html\">replaces | transforms | signs | appends</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The target document of this relationship.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.relatesTo.target\"><b>target</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"documentreference.html#DocumentReference\">DocumentReference</a>)</span> <span style=\"color: navy\">Target of the relationship</span><span style=\"color: Gray\"> --></span></target>\r\n </relatesTo>\r\n <<a title=\"Human-readable description of the source document. This is sometimes known as the "title".\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Human-readable description (title)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A code specifying the level of confidentiality of the XDS Document (this element modifies the meaning of other elements)\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.confidentiality\"><span style=\"text-decoration: underline\"><b>confidentiality</b></span></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v3/vs/Confidentiality/index.html\">Sensitivity of source document</a><span style=\"color: Gray\"> --></span></confidentiality>\r\n <<a title=\"The primary language in which the source document is written.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.primaryLanguage\"><b>primaryLanguage</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://tools.ietf.org/html/bcp47.html\">The marked primary language for the document</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The mime type of the source document.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.mimeType\"><b>mimeType</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://www.rfc-editor.org/bcp/bcp13.txt.html\">Mime type, + maybe character encoding</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"An identifier that identifies that the format and content of the document conforms to additional rules beyond the base format indicated in the mimeType.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.format\"><b>format</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: navy\">Format/content rules for the document</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The size of the source document this reference refers to in bytes.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.size\"><b>size</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Size of the document in bytes</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A hash of the source document to ensure that changes have not occurred.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.hash\"><b>hash</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">HexBinary representation of SHA1</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A url at which the document can be accessed.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.location\"><b>location</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: A location or a service (or both) SHALL be provided\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Where to access the document</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A description of a service call that can be used to retrieve the document.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.service\"><b>service</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-1: A location or a service (or both) SHALL be provided\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> If access is not fully described by location --></span>\r\n <<a title=\"The type of the service that can be used to access the documents.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.service.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-documentreference-service-types.html\">Type of service (i.e. XDS.b)</a></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"Where the service end-point is located.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.service.address\"><b>address</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Where service is located (usually a URL)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A list of named parameters that is used in the service call.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.service.parameter\"><b>parameter</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Service call parameters --></span>\r\n <<a title=\"The name of a parameter.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.service.parameter.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Parameter name in service call</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The value of the named parameter.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.service.parameter.value\"><b>value</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Parameter value for the name</span><span style=\"color: Gray\"> --></span>\r\n </parameter>\r\n </service>\r\n <<a title=\"The clinical context in which the document was prepared.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.context\"><b>context</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> Clinical context of document --></span>\r\n <<a title=\"This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.context.event\"><b>event</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v3/ActCode/index.html\">Main Clinical Acts Documented</a><span style=\"color: Gray\"> --></span></event>\r\n <<a title=\"The time period over which the service that is described by the document was provided.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.context.period\"><b>period</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">Time of service that is being documented</span><span style=\"color: Gray\"> --></span></period>\r\n <<a title=\"The kind of facility where the patient was seen.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.context.facilityType\"><b>facilityType</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-xds-facilitycodes.html\">Kind of facility where patient was seen</a></span><span style=\"color: Gray\"> --></span></facilityType>\r\n </context>\r\n</DocumentReference>\r\n</pre></div>"
},
"name": "documentreference",
"publisher": "FHIR Project",
"description": "Basic Profile. A reference to a document.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage A document reference resource is used to describe a document that is made available to a healthcare system. A document is some sequence of bytes that is identifiable, establishes its own context (e.g. what subject, author etc), can be displayed to the user, and has defined update management. The document resource can be used with any document format that has a recognized mime type, and that conforms to this definition. \r\n\r\nTypically, Document Reference Resources are used in document indexing systems, such as IHE XDS (see the XDS specific profile), and are used to refer to: \r\n\r\n* CDA documents in FHIR systems\r\n* FHIR documents stored elsewhere (i.e. registry/repository following the XDS model)\r\n* PDF documents, and even digital records of faxes where sufficient information is available\r\n* Other kinds of documents, such as records of prescriptions.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "DocumentReference",
"publish": true,
"element": [
{
"path": "DocumentReference",
"definition": {
"short": "A reference to a document",
"formal": "A reference to a document.",
"comments": "Usually, this is used for documents other than those defined by FHIR.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"constraint": [
{
"key": "1",
"name": "Location",
"severity": "error",
"human": "A location or a service (or both) SHALL be provided",
"xpath": "exists(f:location) or exists(f:service)"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Document[classCode=\"DOC\" and moodCode=\"EVN\"]"
}
]
}
},
{
"path": "DocumentReference.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DocumentReference.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DocumentReference.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "DocumentReference.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "DocumentReference.masterIdentifier",
"definition": {
"short": "Master Version Specific Identifier",
"formal": "Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.",
"min": 1,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "v2",
"map": "TXA-12-Unique Document Number"
}
]
}
},
{
"path": "DocumentReference.identifier",
"definition": {
"short": "Other identifiers for the document",
"formal": "Other identifiers associated with the document, including version independent, source record and workflow related identifiers.",
"comments": "Other identifiers can also include Identifiers may be Accession Numbers, Order Numbers, Referral Request \nIdentifiers, XDS Workflow Instance Identifiers.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id / .setId"
},
{
"identity": "v2",
"map": "TXA-16-Unique Document File Name?"
}
]
}
},
{
"path": "DocumentReference.subject",
"definition": {
"short": "Who|what is the subject of the document",
"formal": "Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (I.e. machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Group"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=\"SBJ\"].role[typeCode=\"PAT\"]"
},
{
"identity": "v2",
"map": "PID-3-Patient ID List (No standard way to define a Practitioner or Group subject in V2 MDM message)"
}
]
}
},
{
"path": "DocumentReference.type",
"definition": {
"short": "What kind of document this is (LOINC if possible)",
"formal": "Specifies the particular kind of document (e.g. Patient Summary, Discharge Summary, Prescription, etc.).",
"comments": "Key metadata element describing the document, used in searching/filtering.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "DocumentType",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/doc-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": "./code"
},
{
"identity": "v2",
"map": "TXA-2-Document Type"
}
]
}
},
{
"path": "DocumentReference.class",
"definition": {
"short": "Categorization of Document",
"formal": "A categorization for the type of the document. This may be implied by or derived from the code specified in the Document Type.",
"comments": "Helps humans to assess whether the document is of interest when viewing an index of documents.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "DocumentClass",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/xds-typecodes"
}
},
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"
},
{
"identity": "v2",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"
}
]
}
},
{
"path": "DocumentReference.author",
"definition": {
"short": "Who and/or what authored the document",
"formal": "Identifies who is responsible for adding the information to the document.",
"comments": "Not necessarily who did the actual data entry (i.e. typist) it in or who was the source (informant).",
"min": 1,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/RelatedPerson"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=\"AUT\"].role[classCode=\"ASSIGNED\"]"
},
{
"identity": "v2",
"map": "TXA-9-Originator Code/Name (No standard way to indicate a Device in V2 MDM message)"
}
]
}
},
{
"path": "DocumentReference.custodian",
"definition": {
"short": "Org which maintains the document",
"formal": "Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.",
"comments": "Identifies the logical organization to go to find the current version, where to report issues, etc. This is different from the physical location of the document, which is the technical location of the document, which host may be delegated to the management of some other organization.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=\"RCV\"].role[classCode=\"CUST\"].scoper[classCode=\"ORG\" and determinerCode=\"INST\"]"
}
]
}
},
{
"path": "DocumentReference.policyManager",
"definition": {
"short": "Manages access policies for the document",
"formal": "A reference to a domain or server that manages policies under which the document is accessed and/or made available.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A - New participation type required"
}
]
}
},
{
"path": "DocumentReference.authenticator",
"definition": {
"short": "Who/What authenticated the document",
"formal": "Which person or organization authenticates that this document is valid.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=\"AUTHEN\"].role[classCode=\"ASSIGNED\"]"
},
{
"identity": "v2",
"map": "TXA-10-Assigned Document Authenticator"
}
]
}
},
{
"path": "DocumentReference.created",
"definition": {
"short": "Document creation time",
"formal": "When the document was created.",
"comments": "Creation time is used for tracking, organizing versions and searching. This is the creation time of the document, not the source material on which it is based.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime[type=\"TS\"]"
},
{
"identity": "v2",
"map": "TXA-6-Origination Date/Time"
}
]
}
},
{
"path": "DocumentReference.indexed",
"definition": {
"short": "When this document reference created",
"formal": "When the document reference was created.",
"comments": "Referencing/indexing time is used for tracking, organizing versions and searching.",
"min": 1,
"max": "1",
"type": [
{
"code": "instant"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".availabilityTime[type=\"TS\"]"
}
]
}
},
{
"path": "DocumentReference.status",
"definition": {
"short": "current | superceded | entered in error",
"formal": "The status of this document reference.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "DocumentReferenceStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/document-reference-status"
}
},
"mapping": [
{
"identity": "rim",
"map": "interim: .completionCode=\"IN\" & ./statusCode[isNormalDatatype()]=\"active\";\n\nfinal: .completionCode=\"AU\" && ./statusCode[isNormalDatatype()]=\"complete\" and not(./inboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#CACT\") and moodCode=\"EVN\" and domainMember(\"ReviseDocument\", code) and isNormalAct()]);\n\namended: .completionCode=\"AU\" && ./statusCode[isNormalDatatype()]=\"complete\" and ./inboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#CACT\") and moodCode=\"EVN\" and domainMember(\"ReviseDocument\", code) and isNormalAct() and statusCode=\"completed\"];\n\nwithdrawn : .completionCode=NI && ./statusCode[isNormalDatatype()]=\"obsolete\""
},
{
"identity": "v2",
"map": "TXA-19-Document Availability Status"
}
]
}
},
{
"path": "DocumentReference.docStatus",
"definition": {
"short": "preliminary | final | appended | amended | entered in error",
"formal": "The status of the underlying document.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ReferredDocumentStatus",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/composition-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode"
},
{
"identity": "v2",
"map": "TXA-17-Document Completion Status"
}
]
}
},
{
"path": "DocumentReference.relatesTo",
"definition": {
"short": "Relationships to other documents",
"formal": "Relationships that this document has with other document references that already exist.",
"min": 0,
"max": "*",
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship"
}
]
}
},
{
"path": "DocumentReference.relatesTo.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DocumentReference.relatesTo.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DocumentReference.relatesTo.code",
"definition": {
"short": "replaces | transforms | signs | appends",
"formal": "The type of relationship that this document has with anther document.",
"comments": "If this document appends another document, then the document cannot be fully understood without also accessing the referenced document.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "DocumentRelationshipType",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/document-relationship-type"
}
},
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship.typeCode"
}
]
}
},
{
"path": "DocumentReference.relatesTo.target",
"definition": {
"short": "Target of the relationship",
"formal": "The target document of this relationship.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/DocumentReference"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".target[classCode=\"DOC\", moodCode=\"EVN\"].id"
}
]
}
},
{
"path": "DocumentReference.description",
"definition": {
"short": "Human-readable description (title)",
"formal": "Human-readable description of the source document. This is sometimes known as the \"title\".",
"comments": "What the document is about, rather than a terse summary of the document. It is commonly the case that records do not have a title and are collectively referred to by the display name of Record code (e.g. a \"consultation\" or \"progress note\").",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"SUBJ\"].target.text"
},
{
"identity": "v2",
"map": "TXA-25-Document Title"
}
]
}
},
{
"path": "DocumentReference.confidentiality",
"definition": {
"short": "Sensitivity of source document",
"formal": "A code specifying the level of confidentiality of the XDS Document.",
"comments": "The interpretation of this field, and more generally enforcement and issues related to highly sensitive documents are beyond the scope of this resource. confidentialityCode can only be understood in the context of the policies, procedures, and value set specified by the context in which the document reference is being used.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": true,
"binding": {
"name": "DocumentConfidentiality",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/v3/vs/Confidentiality"
}
},
"mapping": [
{
"identity": "rim",
"map": ".confidentialityCode"
},
{
"identity": "v2",
"map": "TXA-18-Document Confidentiality Status"
}
]
}
},
{
"path": "DocumentReference.primaryLanguage",
"definition": {
"short": "The marked primary language for the document",
"formal": "The primary language in which the source document is written.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "Language",
"isExtensible": false,
"conformance": "required",
"referenceUri": "http://tools.ietf.org/html/bcp47"
},
"mapping": [
{
"identity": "rim",
"map": ".languageCode"
}
]
}
},
{
"path": "DocumentReference.mimeType",
"definition": {
"short": "Mime type, + maybe character encoding",
"formal": "The mime type of the source document.",
"comments": "Note: application/hl7-v3+xml for CDA. application/binary for proprietary record formats.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "MimeType",
"isExtensible": false,
"conformance": "required",
"referenceUri": "http://www.rfc-editor.org/bcp/bcp13.txt"
},
"mapping": [
{
"identity": "rim",
"map": ".text.mediaType"
},
{
"identity": "v2",
"map": "TXA-3-Document Content Presentation"
}
]
}
},
{
"path": "DocumentReference.format",
"definition": {
"short": "Format/content rules for the document",
"formal": "An identifier that identifies that the format and content of the document conforms to additional rules beyond the base format indicated in the mimeType.",
"comments": "Most often used when the mime-type is text/xml.",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
}
},
{
"path": "DocumentReference.size",
"definition": {
"short": "Size of the document in bytes",
"formal": "The size of the source document this reference refers to in bytes.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".text.length"
}
]
}
},
{
"path": "DocumentReference.hash",
"definition": {
"short": "HexBinary representation of SHA1",
"formal": "A hash of the source document to ensure that changes have not occurred.",
"comments": "Whether the hash must be present and/or correct depends on the document handling rules defined in the context of use.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".text.integrityCheck"
}
]
}
},
{
"path": "DocumentReference.location",
"definition": {
"short": "Where to access the document",
"formal": "A url at which the document can be accessed.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".text.reference"
},
{
"identity": "v2",
"map": "(Might include V2 TXA-16-Unique Document File Name or TXA-24-Folder Assignment)"
}
]
}
},
{
"path": "DocumentReference.service",
"definition": {
"short": "If access is not fully described by location",
"formal": "A description of a service call that can be used to retrieve the document.",
"comments": "If a document can be accessed by either a service or directly by a URL (i.e. an XDS repository with an MHD access point, or a DICOM network with a WADO portal) just provide the URL.",
"min": 0,
"max": "1",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".text.reference"
}
]
}
},
{
"path": "DocumentReference.service.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DocumentReference.service.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DocumentReference.service.type",
"definition": {
"short": "Type of service (i.e. XDS.b)",
"formal": "The type of the service that can be used to access the documents.",
"comments": "The meaning and interpretation of the parameters depends on the service type.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "DocumentServiceType",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/documentreference-service-types"
}
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
}
},
{
"path": "DocumentReference.service.address",
"definition": {
"short": "Where service is located (usually a URL)",
"formal": "Where the service end-point is located.",
"comments": "Usually this is a URL, but for some services, the end-point is a simple network name or address that is not a valid URL.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
}
},
{
"path": "DocumentReference.service.parameter",
"definition": {
"short": "Service call parameters",
"formal": "A list of named parameters that is used in the service call.",
"comments": "The interpretation of the parameters, and how to convert them into a proper service call, is dependent on the type of the service, and needs to be specified in an implementation guide somewhere.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
}
},
{
"path": "DocumentReference.service.parameter.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DocumentReference.service.parameter.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DocumentReference.service.parameter.name",
"definition": {
"short": "Parameter name in service call",
"formal": "The name of a parameter.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
}
},
{
"path": "DocumentReference.service.parameter.value",
"definition": {
"short": "Parameter value for the name",
"formal": "The value of the named parameter.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
}
},
{
"path": "DocumentReference.context",
"definition": {
"short": "Clinical context of document",
"formal": "The clinical context in which the document was prepared.",
"comments": "These values are primarily added to help with searching for interesting/relevant documents.",
"min": 0,
"max": "1",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=\"SUBJ\"].target[classCode<'ACT']"
}
]
}
},
{
"path": "DocumentReference.context.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DocumentReference.context.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DocumentReference.context.event",
"definition": {
"short": "Main Clinical Acts Documented",
"formal": "This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a \"History and Physical Report\" in which the procedure being documented is necessarily a \"History and Physical\" act.",
"comments": "An event can further specialize the act inherent in the type, such as \nwhere it is simply \"Procedure Report\" and the procedure was a \"colonoscopy\". If one or more event codes are included, they shall not conflict with the values inherent in the class or type elements as such a conflict would create an ambiguous situation.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "DocumentEventType",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/v3/vs/ActCode"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
}
},
{
"path": "DocumentReference.context.period",
"definition": {
"short": "Time of service that is being documented",
"formal": "The time period over which the service that is described by the document was provided.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
}
},
{
"path": "DocumentReference.context.facilityType",
"definition": {
"short": "Kind of facility where patient was seen",
"formal": "The kind of facility where the patient was seen.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "DocumentFacilityType",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/xds-facilitycodes"
}
},
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=\"LOC\"].role[classCode=\"DSDLOC\"].code"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "authenticator",
"type": "reference",
"documentation": "Who/What authenticated the document",
"xpath": "f:DocumentReference/f:authenticator"
},
{
"name": "author",
"type": "reference",
"documentation": "Who and/or what authored the document",
"xpath": "f:DocumentReference/f:author"
},
{
"name": "class",
"type": "token",
"documentation": "Categorization of Document",
"xpath": "f:DocumentReference/f:class"
},
{
"name": "confidentiality",
"type": "token",
"documentation": "Sensitivity of source document",
"xpath": "f:DocumentReference/f:confidentiality"
},
{
"name": "created",
"type": "date",
"documentation": "Document creation time",
"xpath": "f:DocumentReference/f:created"
},
{
"name": "custodian",
"type": "reference",
"documentation": "Org which maintains the document",
"xpath": "f:DocumentReference/f:custodian"
},
{
"name": "description",
"type": "string",
"documentation": "Human-readable description (title)",
"xpath": "f:DocumentReference/f:description"
},
{
"name": "event",
"type": "token",
"documentation": "Main Clinical Acts Documented",
"xpath": "f:DocumentReference/f:context/f:event"
},
{
"name": "facility",
"type": "token",
"documentation": "Kind of facility where patient was seen",
"xpath": "f:DocumentReference/f:context/f:facilityType"
},
{
"name": "format",
"type": "token",
"documentation": "Format/content rules for the document",
"xpath": "f:DocumentReference/f:format"
},
{
"name": "identifier",
"type": "token",
"documentation": "Master Version Specific Identifier"
},
{
"name": "indexed",
"type": "date",
"documentation": "When this document reference created",
"xpath": "f:DocumentReference/f:indexed"
},
{
"name": "language",
"type": "token",
"documentation": "The marked primary language for the document",
"xpath": "f:DocumentReference/f:primaryLanguage"
},
{
"name": "location",
"type": "string",
"documentation": "Where to access the document",
"xpath": "f:DocumentReference/f:location"
},
{
"name": "period",
"type": "date",
"documentation": "Time of service that is being documented",
"xpath": "f:DocumentReference/f:context/f:period"
},
{
"name": "relatesto",
"type": "reference",
"documentation": "Target of the relationship",
"xpath": "f:DocumentReference/f:relatesTo/f:target"
},
{
"name": "relation",
"type": "token",
"documentation": "replaces | transforms | signs | appends",
"xpath": "f:DocumentReference/f:relatesTo/f:code"
},
{
"name": "relationship",
"type": "composite",
"documentation": "Combination of relation and relatesTo"
},
{
"name": "size",
"type": "number",
"documentation": "Size of the document in bytes",
"xpath": "f:DocumentReference/f:size"
},
{
"name": "status",
"type": "token",
"documentation": "current | superceded | entered in error",
"xpath": "f:DocumentReference/f:status"
},
{
"name": "subject",
"type": "reference",
"documentation": "Who|what is the subject of the document",
"xpath": "f:DocumentReference/f:subject"
},
{
"name": "type",
"type": "token",
"documentation": "What kind of document this is (LOINC if possible)",
"xpath": "f:DocumentReference/f:type"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"A reference to a document.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference\"><b>DocumentReference</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.masterIdentifier\"><b>masterIdentifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Master Version Specific Identifier</span><span style=\"color: Gray\"> --></span></masterIdentifier>\r\n <<a title=\"Other identifiers associated with the document, including version independent, source record and workflow related identifiers.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Other identifiers for the document</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (I.e. machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"group.html#Group\">Group</a>|<a href=\"device.html#Device\">Device</a>)</span> <span style=\"color: navy\">\r\n Who|what is the subject of the document</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"Specifies the particular kind of document (e.g. Patient Summary, Discharge Summary, Prescription, etc.).\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-doc-codes.html\">What kind of document this is (LOINC if possible)</a></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"A categorization for the type of the document. This may be implied by or derived from the code specified in the Document Type.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.class\"><b>class</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-xds-typecodes.html\">Categorization of Document</a></span><span style=\"color: Gray\"> --></span></class>\r\n <<a title=\"Identifies who is responsible for adding the information to the document.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.author\"><b>author</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"device.html#Device\">Device</a>|<a href=\"patient.html#Patient\">Patient</a>|<a href=\"relatedperson.html#RelatedPerson\">RelatedPerson</a>)</span> <span style=\"color: navy\">\r\n Who and/or what authored the document</span><span style=\"color: Gray\"> --></span></author>\r\n <<a title=\"Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.custodian\"><b>custodian</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">Org which maintains the document</span><span style=\"color: Gray\"> --></span></custodian>\r\n <<a title=\"A reference to a domain or server that manages policies under which the document is accessed and/or made available.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.policyManager\"><b>policyManager</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Manages access policies for the document</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Which person or organization authenticates that this document is valid.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.authenticator\"><b>authenticator</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">\r\n Who/What authenticated the document</span><span style=\"color: Gray\"> --></span></authenticator>\r\n <<a title=\"When the document was created.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.created\"><b>created</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Document creation time</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"When the document reference was created.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.indexed\"><b>indexed</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#instant\">instant</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">When this document reference created</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The status of this document reference (this element modifies the meaning of other elements)\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"document-reference-status.html\">current | superceded | entered in error</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The status of the underlying document.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.docStatus\"><b>docStatus</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"composition-status.html\">preliminary | final | appended | amended | entered in error</a><span style=\"color: Gray\"> --></span></docStatus>\r\n <<a title=\"Relationships that this document has with other document references that already exist (this element modifies the meaning of other elements)\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.relatesTo\"><span style=\"text-decoration: underline\"><b>relatesTo</b></span></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Relationships to other documents --></span>\r\n <<a title=\"The type of relationship that this document has with anther document.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.relatesTo.code\"><b>code</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"document-relationship-type.html\">replaces | transforms | signs | appends</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The target document of this relationship.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.relatesTo.target\"><b>target</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"documentreference.html#DocumentReference\">DocumentReference</a>)</span> <span style=\"color: navy\">Target of the relationship</span><span style=\"color: Gray\"> --></span></target>\r\n </relatesTo>\r\n <<a title=\"Human-readable description of the source document. This is sometimes known as the "title".\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Human-readable description (title)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A code specifying the level of confidentiality of the XDS Document (this element modifies the meaning of other elements)\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.confidentiality\"><span style=\"text-decoration: underline\"><b>confidentiality</b></span></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v3/vs/Confidentiality/index.html\">Sensitivity of source document</a><span style=\"color: Gray\"> --></span></confidentiality>\r\n <<a title=\"The primary language in which the source document is written.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.primaryLanguage\"><b>primaryLanguage</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://tools.ietf.org/html/bcp47.html\">The marked primary language for the document</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The mime type of the source document.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.mimeType\"><b>mimeType</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://www.rfc-editor.org/bcp/bcp13.txt.html\">Mime type, + maybe character encoding</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"An identifier that identifies that the format and content of the document conforms to additional rules beyond the base format indicated in the mimeType.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.format\"><b>format</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: navy\">Format/content rules for the document</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The size of the source document this reference refers to in bytes.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.size\"><b>size</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Size of the document in bytes</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A hash of the source document to ensure that changes have not occurred.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.hash\"><b>hash</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">HexBinary representation of SHA1</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A url at which the document can be accessed.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.location\"><b>location</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: A location or a service (or both) SHALL be provided\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Where to access the document</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A description of a service call that can be used to retrieve the document.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.service\"><b>service</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-1: A location or a service (or both) SHALL be provided\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> If access is not fully described by location --></span>\r\n <<a title=\"The type of the service that can be used to access the documents.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.service.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-documentreference-service-types.html\">Type of service (i.e. XDS.b)</a></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"Where the service end-point is located.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.service.address\"><b>address</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Where service is located (usually a URL)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A list of named parameters that is used in the service call.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.service.parameter\"><b>parameter</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Service call parameters --></span>\r\n <<a title=\"The name of a parameter.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.service.parameter.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Parameter name in service call</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The value of the named parameter.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.service.parameter.value\"><b>value</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Parameter value for the name</span><span style=\"color: Gray\"> --></span>\r\n </parameter>\r\n </service>\r\n <<a title=\"The clinical context in which the document was prepared.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.context\"><b>context</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> Clinical context of document --></span>\r\n <<a title=\"This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.context.event\"><b>event</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v3/ActCode/index.html\">Main Clinical Acts Documented</a><span style=\"color: Gray\"> --></span></event>\r\n <<a title=\"The time period over which the service that is described by the document was provided.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.context.period\"><b>period</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">Time of service that is being documented</span><span style=\"color: Gray\"> --></span></period>\r\n <<a title=\"The kind of facility where the patient was seen.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.context.facilityType\"><b>facilityType</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-xds-facilitycodes.html\">Kind of facility where patient was seen</a></span><span style=\"color: Gray\"> --></span></facilityType>\r\n </context>\r\n</DocumentReference>\r\n</pre></div>"
},
{
"title": "\"encounter\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/encounter",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/encounter.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.\" class=\"dict\" href=\"encounter-definitions.html#Encounter\"><b>Encounter</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Identifier(s) by which this encounter is known.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Identifier(s) by which this encounter is known<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"planned | in progress | onleave | finished | cancelled (this element modifies the meaning of other elements)\" class=\"dict\" href=\"encounter-definitions.html#Encounter.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"encounter-state.html\">planned | in progress | onleave | finished | cancelled<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"inpatient | outpatient | ambulatory | emergency + (this element modifies the meaning of other elements)\" class=\"dict\" href=\"encounter-definitions.html#Encounter.class\"><span style=\"text-decoration: underline\"><b>class</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"encounter-class.html\">inpatient | outpatient | ambulatory | emergency +<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).\" class=\"dict\" href=\"encounter-definitions.html#Encounter.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-encounter-type.html\">Specific type of encounter<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"The patient present at the encounter.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">The patient present at the encounter<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"The main practitioner responsible for providing the service.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.participant\"><b>participant</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> List of participants involved in the encounter<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span> --></span>\r\n <<a title=\"Role of participant in encounter.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.participant.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-encounter-participant-type.html\">Role of participant in encounter<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"Persons involved in the encounter other than the patient.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.participant.individual\"><b>individual</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"relatedperson.html#RelatedPerson\">RelatedPerson</a>)</span> <span style=\"color: navy\">\r\n Persons involved in the encounter other than the patient<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></individual>\r\n </participant>\r\n <<a title=\"The start and end time of the encounter.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.period\"><b>period</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">The start and end time of the encounter</span><span style=\"color: Gray\"> --></span></period>\r\n <<a title=\"Quantity of time the encounter lasted. This excludes the time during leaves of absence.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.length\"><b>length</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Duration\">Duration</a></span> <span style=\"color: navy\">Quantity of time the encounter lasted</span><span style=\"color: Gray\"> --></span></length>\r\n <<a title=\"Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.reason\"><b>reason</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-encounter-reason.html\">Reason the encounter takes place (code)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></reason>\r\n <<a title=\"Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.indication\"><b>indication</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">Reason the encounter takes place (resource)</span><span style=\"color: Gray\"> --></span></indication>\r\n <<a title=\"Indicates the urgency of the encounter.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.priority\"><b>priority</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-encounter-priority.html\">Indicates the urgency of the encounter</a></span><span style=\"color: Gray\"> --></span></priority>\r\n <<a title=\"Details about an admission to a clinic.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.hospitalization\"><b>hospitalization</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> Details about an admission to a clinic --></span>\r\n <<a title=\"Pre-admission identifier.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.hospitalization.preAdmissionIdentifier\"><b>preAdmissionIdentifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Pre-admission identifier</span><span style=\"color: Gray\"> --></span></preAdmissionIdentifier>\r\n <<a title=\"The location from which the patient came before admission.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.hospitalization.origin\"><b>origin</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">\r\n The location from which the patient came before admission</span><span style=\"color: Gray\"> --></span></origin>\r\n <<a title=\"From where patient was admitted (physician referral, transfer).\" class=\"dict\" href=\"encounter-definitions.html#Encounter.hospitalization.admitSource\"><b>admitSource</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-encounter-admit-source.html\">From where patient was admitted (physician referral, transfer)</a></span><span style=\"color: Gray\"> --></span></admitSource>\r\n <<a title=\"Period during which the patient was admitted.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.hospitalization.period\"><b>period</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">Period during which the patient was admitted</span><span style=\"color: Gray\"> --></span></period>\r\n <<a title=\"Where the patient stays during this encounter.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.hospitalization.accomodation\"><b>accomodation</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Where the patient stays during this encounter --></span>\r\n <<a title=\"The bed that is assigned to the patient.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.hospitalization.accomodation.bed\"><b>bed</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">The bed that is assigned to the patient</span><span style=\"color: Gray\"> --></span></bed>\r\n <<a title=\"Period during which the patient was assigned the bed.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.hospitalization.accomodation.period\"><b>period</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">Period during which the patient was assigned the bed</span><span style=\"color: Gray\"> --></span></period>\r\n </accomodation>\r\n <<a title=\"Dietary restrictions for the patient.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.hospitalization.diet\"><b>diet</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-encounter-diet.html\">Dietary restrictions for the patient</a></span><span style=\"color: Gray\"> --></span></diet>\r\n <<a title=\"Special courtesies (VIP, board member).\" class=\"dict\" href=\"encounter-definitions.html#Encounter.hospitalization.specialCourtesy\"><b>specialCourtesy</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-encounter-special-courtesy.html\">Special courtesies (VIP, board member)</a></span><span style=\"color: Gray\"> --></span></specialCourtesy>\r\n <<a title=\"Wheelchair, translator, stretcher, etc.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.hospitalization.specialArrangement\"><b>specialArrangement</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-encounter-special-arrangements.html\">Wheelchair, translator, stretcher, etc</a></span><span style=\"color: Gray\"> --></span></specialArrangement>\r\n <<a title=\"Location to which the patient is discharged.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.hospitalization.destination\"><b>destination</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">Location to which the patient is discharged</span><span style=\"color: Gray\"> --></span></destination>\r\n <<a title=\"Category or kind of location after discharge.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.hospitalization.dischargeDisposition\"><b>dischargeDisposition</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-encounter-discharge-disposition.html\">Category or kind of location after discharge</a></span><span style=\"color: Gray\"> --></span></dischargeDisposition>\r\n <<a title=\"The final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.hospitalization.dischargeDiagnosis\"><b>dischargeDiagnosis</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">\r\n The final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete</span><span style=\"color: Gray\"> --></span></dischargeDiagnosis>\r\n <<a title=\"Whether this hospitalization is a readmission.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.hospitalization.reAdmission\"><b>reAdmission</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Is this hospitalization a readmission?</span><span style=\"color: Gray\"> --></span>\r\n </hospitalization>\r\n <<a title=\"List of locations at which the patient has been.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.location\"><b>location</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> List of locations the patient has been at --></span>\r\n <<a title=\"The location where the encounter takes place.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.location.location\"><b>location</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">Location the encounter takes place</span><span style=\"color: Gray\"> --></span></location>\r\n <<a title=\"Time period during which the patient was present at the location.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.location.period\"><b>period</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">Time period during which the patient was present at the location</span><span style=\"color: Gray\"> --></span></period>\r\n </location>\r\n <<a title=\"Department or team providing care.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.serviceProvider\"><b>serviceProvider</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">Department or team providing care</span><span style=\"color: Gray\"> --></span></serviceProvider>\r\n <<a title=\"Another Encounter of which this encounter is a part of (administratively or in time).\" class=\"dict\" href=\"encounter-definitions.html#Encounter.partOf\"><b>partOf</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"encounter.html#Encounter\">Encounter</a>)</span> <span style=\"color: navy\">Another Encounter this encounter is part of</span><span style=\"color: Gray\"> --></span></partOf>\r\n</Encounter>\r\n</pre></div>"
},
"name": "encounter",
"publisher": "FHIR Project",
"description": "Basic Profile. An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage A patient encounter is further characterized by the setting in which it takes place. Amongst them are ambulatory, emergency, home health, inpatient and virtual encounters. An Encounter encompasses the lifecycle from pre-admission, the actual encounter (for ambulatory encounters), and admission, stay and discharge (for inpatient encounters). During the encounter the patient may move from practitioner to practitioner and location to location. \r\n\r\nBecause of the broad scope of Encounter, not all elements will be relevant in all settings. For this reason, admission/discharge related information is kept in a separate Hospitalization component within Encounter. The class element is used to distinguish between these settings, which will guide further validation and application of business rules. \r\n\r\nThere is also substantial variance from organization to organization (and between jurisdictions and countries) on which business events translate to the start of a new Encounter, or what level of aggregation is used for Encounter. For example, each single visit of a practitioner during a hospitalization may lead to a new instance of Encounter, but depending on local practice and the systems involved, it may well be that this is aggregated to a single instance for a whole hospitalization. Even more aggregation may occur where jurisdictions introduce groups of Encounters for financial or other reasons. Encounters can be aggregated or grouped under other Encounters using the partOf element. See below for examples. \r\n\r\nEncounter instances may exist before the actual encounter takes place to convey pre-admission information, including using Encounters elements to reflect the planned start date, planned accommodation or planned encounter locations. In this case the status element is set to 'planned'.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "Encounter",
"publish": true,
"element": [
{
"path": "Encounter",
"definition": {
"short": "An interaction during which services are provided to the patient",
"formal": "An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Encounter[moodCode=EVN]"
}
]
}
},
{
"path": "Encounter.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Encounter.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Encounter.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "Encounter.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "Encounter.identifier",
"definition": {
"short": "Identifier(s) by which this encounter is known",
"formal": "Identifier(s) by which this encounter is known.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "v2",
"map": "PV1-19-visit number"
}
]
}
},
{
"path": "Encounter.status",
"definition": {
"short": "planned | in progress | onleave | finished | cancelled",
"formal": "planned | in progress | onleave | finished | cancelled.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "EncounterState",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/encounter-state"
}
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode"
},
{
"identity": "v2",
"map": "No clear equivalent in V2.x; active/finished could be inferred from PV1-44, PV1-45, PV2-24; inactive could be inferred from PV2-16"
}
]
}
},
{
"path": "Encounter.class",
"definition": {
"short": "inpatient | outpatient | ambulatory | emergency +",
"formal": "inpatient | outpatient | ambulatory | emergency +.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "EncounterClass",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/encounter-class"
}
},
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=LIST].code"
},
{
"identity": "v2",
"map": "PV1-2-patient class"
}
]
}
},
{
"path": "Encounter.type",
"definition": {
"short": "Specific type of encounter",
"formal": "Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).",
"comments": "Since there are many ways to further classify encounters, this element is 0..*.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "EncounterType",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/encounter-type"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "v2",
"map": "PV1-4-admission type"
}
]
}
},
{
"path": "Encounter.subject",
"definition": {
"short": "The patient present at the encounter",
"formal": "The patient present at the encounter.",
"comments": "While the encounter is always about the patient, the patient may not actually be known in all contexts of use.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ]/role[classCode=PAT]"
},
{
"identity": "v2",
"map": "PID-3-patient ID list"
}
]
}
},
{
"path": "Encounter.participant",
"definition": {
"short": "List of participants involved in the encounter",
"formal": "The main practitioner responsible for providing the service.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PFM]"
}
]
}
},
{
"path": "Encounter.participant.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Encounter.participant.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Encounter.participant.type",
"definition": {
"short": "Role of participant in encounter",
"formal": "Role of participant in encounter.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ParticipantType",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/encounter-participant-type"
}
},
"mapping": [
{
"identity": "rim",
"map": ".functionCode"
},
{
"identity": "v2",
"map": "PRT-4-participation"
}
]
}
},
{
"path": "Encounter.participant.individual",
"definition": {
"short": "Persons involved in the encounter other than the patient",
"formal": "Persons involved in the encounter other than the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/RelatedPerson"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".role"
},
{
"identity": "v2",
"map": "PRT-5-participation person"
}
]
}
},
{
"path": "Encounter.period",
"definition": {
"short": "The start and end time of the encounter",
"formal": "The start and end time of the encounter.",
"comments": "If not (yet) known, the end of the Period may be omitted.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime\n(low & high)"
}
]
}
},
{
"path": "Encounter.length",
"definition": {
"short": "Quantity of time the encounter lasted",
"formal": "Quantity of time the encounter lasted. This excludes the time during leaves of absence.",
"comments": "May differ from the time the Encounter.period lasted because of leave of absence.",
"min": 0,
"max": "1",
"type": [
{
"code": "Duration"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".lengthOfStayQuantity"
},
{
"identity": "v2",
"map": "(PV1-45 less PV1-44) iff ( (PV1-44 not empty) and (PV1-45 not empty) ); units in minutes"
}
]
}
},
{
"path": "Encounter.reason",
"definition": {
"short": "Reason the encounter takes place (code)",
"formal": "Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "EncounterReason",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/encounter-reason"
}
},
"mapping": [
{
"identity": "rim",
"map": ".reasonCode"
},
{
"identity": "v2",
"map": "EVN-4-event reason code / PV2-3-admit reason (note: PV2-3 is nominally constrained to inpatient admissions; V2.x makes no vocabulary suggestions for PV2-3; would not expect PV2 segment or PV2-3 to be in use in all implementations\n)"
}
]
}
},
{
"path": "Encounter.indication",
"definition": {
"short": "Reason the encounter takes place (resource)",
"formal": "Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Any"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RSON].target"
}
]
}
},
{
"path": "Encounter.priority",
"definition": {
"short": "Indicates the urgency of the encounter",
"formal": "Indicates the urgency of the encounter.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "Priority",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/encounter-priority"
}
},
"mapping": [
{
"identity": "rim",
"map": ".priorityCode"
},
{
"identity": "v2",
"map": "PV2-25-visit priority code"
}
]
}
},
{
"path": "Encounter.hospitalization",
"definition": {
"short": "Details about an admission to a clinic",
"formal": "Details about an admission to a clinic.",
"min": 0,
"max": "1",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=ENC, moodCode=EVN]"
}
]
}
},
{
"path": "Encounter.hospitalization.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Encounter.hospitalization.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Encounter.hospitalization.preAdmissionIdentifier",
"definition": {
"short": "Pre-admission identifier",
"formal": "Pre-admission identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "v2",
"map": "PV1-5-preadmit number"
}
]
}
},
{
"path": "Encounter.hospitalization.origin",
"definition": {
"short": "The location from which the patient came before admission",
"formal": "The location from which the patient came before admission.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Location"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=ORG].role"
}
]
}
},
{
"path": "Encounter.hospitalization.admitSource",
"definition": {
"short": "From where patient was admitted (physician referral, transfer)",
"formal": "From where patient was admitted (physician referral, transfer).",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "AdmitSource",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/encounter-admit-source"
}
},
"mapping": [
{
"identity": "rim",
"map": ".admissionReferralSourceCode"
},
{
"identity": "v2",
"map": "PV1-14-admit source"
}
]
}
},
{
"path": "Encounter.hospitalization.period",
"definition": {
"short": "Period during which the patient was admitted",
"formal": "Period during which the patient was admitted.",
"comments": "May differ from start + length, since length excludes leaves of absence.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "v2",
"map": "PV2-11-actual length of inpatient stay / PV1-44-admit date/time / PV1-45-discharge date/time"
}
]
}
},
{
"path": "Encounter.hospitalization.accomodation",
"definition": {
"short": "Where the patient stays during this encounter",
"formal": "Where the patient stays during this encounter.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=ACCOM, moodCode=EVN]"
}
]
}
},
{
"path": "Encounter.hospitalization.accomodation.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Encounter.hospitalization.accomodation.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Encounter.hospitalization.accomodation.bed",
"definition": {
"short": "The bed that is assigned to the patient",
"formal": "The bed that is assigned to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Location"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=LOC].role.player[classCode=PLC, code=BED]"
},
{
"identity": "v2",
"map": "PV1-3-assigned patient location"
}
]
}
},
{
"path": "Encounter.hospitalization.accomodation.period",
"definition": {
"short": "Period during which the patient was assigned the bed",
"formal": "Period during which the patient was assigned the bed.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
}
},
{
"path": "Encounter.hospitalization.diet",
"definition": {
"short": "Dietary restrictions for the patient",
"formal": "Dietary restrictions for the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "PatientDiet",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/encounter-diet"
}
},
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=SBADM, moodCode=EVN, code=\"diet\"]"
},
{
"identity": "v2",
"map": "PV1-38-diet type"
}
]
}
},
{
"path": "Encounter.hospitalization.specialCourtesy",
"definition": {
"short": "Special courtesies (VIP, board member)",
"formal": "Special courtesies (VIP, board member).",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "Courtesies",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/encounter-special-courtesy"
}
},
"mapping": [
{
"identity": "rim",
"map": ".specialCourtesiesCode"
},
{
"identity": "v2",
"map": "PV1-16-VIP indicator"
}
]
}
},
{
"path": "Encounter.hospitalization.specialArrangement",
"definition": {
"short": "Wheelchair, translator, stretcher, etc",
"formal": "Wheelchair, translator, stretcher, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "Arrangements",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/encounter-special-arrangements"
}
},
"mapping": [
{
"identity": "rim",
"map": ".specialArrangementCode"
},
{
"identity": "v2",
"map": "PV1-15-ambulatory status / OBR-30-transportation mode / OBR-43-planned patient transport comment"
}
]
}
},
{
"path": "Encounter.hospitalization.destination",
"definition": {
"short": "Location to which the patient is discharged",
"formal": "Location to which the patient is discharged.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Location"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=DST]"
}
]
}
},
{
"path": "Encounter.hospitalization.dischargeDisposition",
"definition": {
"short": "Category or kind of location after discharge",
"formal": "Category or kind of location after discharge.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "DischargeDisp",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/encounter-discharge-disposition"
}
},
"mapping": [
{
"identity": "rim",
"map": ".dischargeDispositionCode"
},
{
"identity": "v2",
"map": "PV1-36-discharge disposition"
}
]
}
},
{
"path": "Encounter.hospitalization.dischargeDiagnosis",
"definition": {
"short": "The final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete",
"formal": "The final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Any"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=OUT].target[classCode=OBS, moodCode=EVN, code=ASSERTION].value"
}
]
}
},
{
"path": "Encounter.hospitalization.reAdmission",
"definition": {
"short": "Is this hospitalization a readmission?",
"formal": "Whether this hospitalization is a readmission.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Propose at harmonization"
},
{
"identity": "v2",
"map": "PV1-13-re-admission indicator"
}
]
}
},
{
"path": "Encounter.location",
"definition": {
"short": "List of locations the patient has been at",
"formal": "List of locations at which the patient has been.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=LOC]"
}
]
}
},
{
"path": "Encounter.location.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Encounter.location.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Encounter.location.location",
"definition": {
"short": "Location the encounter takes place",
"formal": "The location where the encounter takes place.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Location"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".role"
},
{
"identity": "v2",
"map": "PV1-3-assigned patient location / PV1-6-prior patient location / PV1-11-temporary location / PV1-42-pending location / PV1-43-prior temporary location"
}
]
}
},
{
"path": "Encounter.location.period",
"definition": {
"short": "Time period during which the patient was present at the location",
"formal": "Time period during which the patient was present at the location.",
"min": 1,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".time"
}
]
}
},
{
"path": "Encounter.serviceProvider",
"definition": {
"short": "Department or team providing care",
"formal": "Department or team providing care.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".particiaption[typeCode=PFM].role"
},
{
"identity": "v2",
"map": "PV1-10-hospital service / PL.6 Person Location Type & PL.1 Point of Care (note: V2.x definition is \"the treatment or type of surgery that the patient is scheduled to receive\"; seems slightly out of alignment with the concept name 'hospital service'. Would not trust that implementations apply this semantic by default)"
}
]
}
},
{
"path": "Encounter.partOf",
"definition": {
"short": "Another Encounter this encounter is part of",
"formal": "Another Encounter of which this encounter is a part of (administratively or in time).",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Encounter"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=COMP, moodCode=EVN]"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "date",
"type": "date",
"documentation": "A date within the period the Encounter lasted",
"xpath": "f:Encounter/f:period"
},
{
"name": "identifier",
"type": "token",
"documentation": "Identifier(s) by which this encounter is known",
"xpath": "f:Encounter/f:identifier"
},
{
"name": "indication",
"type": "reference",
"documentation": "Reason the encounter takes place (resource)",
"xpath": "f:Encounter/f:indication"
},
{
"name": "length",
"type": "number",
"documentation": "Length of encounter in days",
"xpath": "f:Encounter/f:length"
},
{
"name": "location",
"type": "reference",
"documentation": "Location the encounter takes place",
"xpath": "f:Encounter/f:location/f:location"
},
{
"name": "location-period",
"type": "date",
"documentation": "Time period during which the patient was present at the location",
"xpath": "f:Encounter/f:location/f:period"
},
{
"name": "status",
"type": "token",
"documentation": "planned | in progress | onleave | finished | cancelled",
"xpath": "f:Encounter/f:status"
},
{
"name": "subject",
"type": "reference",
"documentation": "The patient present at the encounter",
"xpath": "f:Encounter/f:subject"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.\" class=\"dict\" href=\"encounter-definitions.html#Encounter\"><b>Encounter</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Identifier(s) by which this encounter is known.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Identifier(s) by which this encounter is known<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"planned | in progress | onleave | finished | cancelled (this element modifies the meaning of other elements)\" class=\"dict\" href=\"encounter-definitions.html#Encounter.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"encounter-state.html\">planned | in progress | onleave | finished | cancelled<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"inpatient | outpatient | ambulatory | emergency + (this element modifies the meaning of other elements)\" class=\"dict\" href=\"encounter-definitions.html#Encounter.class\"><span style=\"text-decoration: underline\"><b>class</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"encounter-class.html\">inpatient | outpatient | ambulatory | emergency +<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).\" class=\"dict\" href=\"encounter-definitions.html#Encounter.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-encounter-type.html\">Specific type of encounter<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"The patient present at the encounter.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">The patient present at the encounter<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"The main practitioner responsible for providing the service.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.participant\"><b>participant</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> List of participants involved in the encounter<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span> --></span>\r\n <<a title=\"Role of participant in encounter.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.participant.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-encounter-participant-type.html\">Role of participant in encounter<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"Persons involved in the encounter other than the patient.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.participant.individual\"><b>individual</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"relatedperson.html#RelatedPerson\">RelatedPerson</a>)</span> <span style=\"color: navy\">\r\n Persons involved in the encounter other than the patient<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></individual>\r\n </participant>\r\n <<a title=\"The start and end time of the encounter.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.period\"><b>period</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">The start and end time of the encounter</span><span style=\"color: Gray\"> --></span></period>\r\n <<a title=\"Quantity of time the encounter lasted. This excludes the time during leaves of absence.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.length\"><b>length</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Duration\">Duration</a></span> <span style=\"color: navy\">Quantity of time the encounter lasted</span><span style=\"color: Gray\"> --></span></length>\r\n <<a title=\"Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.reason\"><b>reason</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-encounter-reason.html\">Reason the encounter takes place (code)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></reason>\r\n <<a title=\"Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.indication\"><b>indication</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">Reason the encounter takes place (resource)</span><span style=\"color: Gray\"> --></span></indication>\r\n <<a title=\"Indicates the urgency of the encounter.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.priority\"><b>priority</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-encounter-priority.html\">Indicates the urgency of the encounter</a></span><span style=\"color: Gray\"> --></span></priority>\r\n <<a title=\"Details about an admission to a clinic.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.hospitalization\"><b>hospitalization</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> Details about an admission to a clinic --></span>\r\n <<a title=\"Pre-admission identifier.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.hospitalization.preAdmissionIdentifier\"><b>preAdmissionIdentifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Pre-admission identifier</span><span style=\"color: Gray\"> --></span></preAdmissionIdentifier>\r\n <<a title=\"The location from which the patient came before admission.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.hospitalization.origin\"><b>origin</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">\r\n The location from which the patient came before admission</span><span style=\"color: Gray\"> --></span></origin>\r\n <<a title=\"From where patient was admitted (physician referral, transfer).\" class=\"dict\" href=\"encounter-definitions.html#Encounter.hospitalization.admitSource\"><b>admitSource</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-encounter-admit-source.html\">From where patient was admitted (physician referral, transfer)</a></span><span style=\"color: Gray\"> --></span></admitSource>\r\n <<a title=\"Period during which the patient was admitted.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.hospitalization.period\"><b>period</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">Period during which the patient was admitted</span><span style=\"color: Gray\"> --></span></period>\r\n <<a title=\"Where the patient stays during this encounter.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.hospitalization.accomodation\"><b>accomodation</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Where the patient stays during this encounter --></span>\r\n <<a title=\"The bed that is assigned to the patient.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.hospitalization.accomodation.bed\"><b>bed</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">The bed that is assigned to the patient</span><span style=\"color: Gray\"> --></span></bed>\r\n <<a title=\"Period during which the patient was assigned the bed.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.hospitalization.accomodation.period\"><b>period</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">Period during which the patient was assigned the bed</span><span style=\"color: Gray\"> --></span></period>\r\n </accomodation>\r\n <<a title=\"Dietary restrictions for the patient.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.hospitalization.diet\"><b>diet</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-encounter-diet.html\">Dietary restrictions for the patient</a></span><span style=\"color: Gray\"> --></span></diet>\r\n <<a title=\"Special courtesies (VIP, board member).\" class=\"dict\" href=\"encounter-definitions.html#Encounter.hospitalization.specialCourtesy\"><b>specialCourtesy</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-encounter-special-courtesy.html\">Special courtesies (VIP, board member)</a></span><span style=\"color: Gray\"> --></span></specialCourtesy>\r\n <<a title=\"Wheelchair, translator, stretcher, etc.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.hospitalization.specialArrangement\"><b>specialArrangement</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-encounter-special-arrangements.html\">Wheelchair, translator, stretcher, etc</a></span><span style=\"color: Gray\"> --></span></specialArrangement>\r\n <<a title=\"Location to which the patient is discharged.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.hospitalization.destination\"><b>destination</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">Location to which the patient is discharged</span><span style=\"color: Gray\"> --></span></destination>\r\n <<a title=\"Category or kind of location after discharge.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.hospitalization.dischargeDisposition\"><b>dischargeDisposition</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-encounter-discharge-disposition.html\">Category or kind of location after discharge</a></span><span style=\"color: Gray\"> --></span></dischargeDisposition>\r\n <<a title=\"The final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.hospitalization.dischargeDiagnosis\"><b>dischargeDiagnosis</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">\r\n The final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete</span><span style=\"color: Gray\"> --></span></dischargeDiagnosis>\r\n <<a title=\"Whether this hospitalization is a readmission.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.hospitalization.reAdmission\"><b>reAdmission</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Is this hospitalization a readmission?</span><span style=\"color: Gray\"> --></span>\r\n </hospitalization>\r\n <<a title=\"List of locations at which the patient has been.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.location\"><b>location</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> List of locations the patient has been at --></span>\r\n <<a title=\"The location where the encounter takes place.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.location.location\"><b>location</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">Location the encounter takes place</span><span style=\"color: Gray\"> --></span></location>\r\n <<a title=\"Time period during which the patient was present at the location.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.location.period\"><b>period</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">Time period during which the patient was present at the location</span><span style=\"color: Gray\"> --></span></period>\r\n </location>\r\n <<a title=\"Department or team providing care.\" class=\"dict\" href=\"encounter-definitions.html#Encounter.serviceProvider\"><b>serviceProvider</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">Department or team providing care</span><span style=\"color: Gray\"> --></span></serviceProvider>\r\n <<a title=\"Another Encounter of which this encounter is a part of (administratively or in time).\" class=\"dict\" href=\"encounter-definitions.html#Encounter.partOf\"><b>partOf</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"encounter.html#Encounter\">Encounter</a>)</span> <span style=\"color: navy\">Another Encounter this encounter is part of</span><span style=\"color: Gray\"> --></span></partOf>\r\n</Encounter>\r\n</pre></div>"
},
{
"title": "\"familyhistory\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/familyhistory",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/familyhistory.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"Significant health events and conditions for people related to the subject relevant in the context of care for the subject.\" class=\"dict\" href=\"familyhistory-definitions.html#FamilyHistory\"><b>FamilyHistory</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"This records identifiers associated with this family history record that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).\" class=\"dict\" href=\"familyhistory-definitions.html#FamilyHistory.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">External Id(s) for this record<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"The person who this history concerns.\" class=\"dict\" href=\"familyhistory-definitions.html#FamilyHistory.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Patient history is about<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"Conveys information about family history not specific to individual relations.\" class=\"dict\" href=\"familyhistory-definitions.html#FamilyHistory.note\"><b>note</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Additional details not covered elsewhere</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The related person. Each FamilyHistory resource contains the entire family history for a single person.\" class=\"dict\" href=\"familyhistory-definitions.html#FamilyHistory.relation\"><b>relation</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Relative described by history --></span>\r\n <<a title=\"This will either be a name or a description. E.g. "Aunt Susan", "my cousin with the red hair".\" class=\"dict\" href=\"familyhistory-definitions.html#FamilyHistory.relation.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">The family member described<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The type of relationship this person has to the patient (father, mother, brother etc.).\" class=\"dict\" href=\"familyhistory-definitions.html#FamilyHistory.relation.relationship\"><b>relationship</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v3/vs/FamilyMember/index.html\">Relationship to the subject<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a><span style=\"color: Gray\"> --></span></relationship>\r\n <<a title=\"The actual or approximate date of birth of the relative.\" class=\"dict\" href=\"familyhistory-definitions.html#FamilyHistory.relation.born_x_\"><b>born[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a>|<a href=\"datatypes.html#date\">date</a>|<a href=\"datatypes.html#string\">string</a></span> <span style=\"color: navy\">(approximate) date of birth</span><span style=\"color: Gray\"> --></span></born[x]>\r\n <<a title=\"If this resource is indicating that the related person is deceased, then an indicator of whether the person is deceased (yes) or not (no) or the age or age range or description of age at death - can be indicated here. If the reason for death is known, then it can be indicated in the outcome code of the condition - in this case the deceased property should still be set.\" class=\"dict\" href=\"familyhistory-definitions.html#FamilyHistory.relation.deceased_x_\"><b>deceased[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a>|<a href=\"datatypes.html#Age\">Age</a>|<a href=\"datatypes.html#Range\">Range</a>|<a href=\"datatypes.html#date\">date</a>|<a href=\"datatypes.html#string\">string</a></span> <span style=\"color: navy\">Dead? How old/when?</span><span style=\"color: Gray\"> --></span></deceased[x]>\r\n <<a title=\"This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.\" class=\"dict\" href=\"familyhistory-definitions.html#FamilyHistory.relation.note\"><b>note</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">General note about related person</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.\" class=\"dict\" href=\"familyhistory-definitions.html#FamilyHistory.relation.condition\"><b>condition</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Condition that the related person had --></span>\r\n <<a title=\"The actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like 'cancer' depending on how much is known about the condition and the capabilities of the creating system.\" class=\"dict\" href=\"familyhistory-definitions.html#FamilyHistory.relation.condition.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Condition suffered by relation</span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"Indicates what happened as a result of this condition. If the condition resulted in death, deceased date is captured on the relation.\" class=\"dict\" href=\"familyhistory-definitions.html#FamilyHistory.relation.condition.outcome\"><b>outcome</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">deceased | permanent disability | etc.</span><span style=\"color: Gray\"> --></span></outcome>\r\n <<a title=\"Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.\" class=\"dict\" href=\"familyhistory-definitions.html#FamilyHistory.relation.condition.onset_x_\"><b>onset[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Age\">Age</a>|<a href=\"datatypes.html#Range\">Range</a>|<a href=\"datatypes.html#string\">string</a></span> <span style=\"color: navy\">When condition first manifested</span><span style=\"color: Gray\"> --></span></onset[x]>\r\n <<a title=\"An area where general notes can be placed about this specific condition.\" class=\"dict\" href=\"familyhistory-definitions.html#FamilyHistory.relation.condition.note\"><b>note</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Extra information about condition</span><span style=\"color: Gray\"> --></span>\r\n </condition>\r\n </relation>\r\n</FamilyHistory>\r\n</pre></div>"
},
"name": "familyhistory",
"publisher": "FHIR Project",
"description": "Basic Profile. Significant health events and conditions for people related to the subject relevant in the context of care for the subject.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage This resource records significant health events and conditions for people related to the subject. This information can be known to different levels of accuracy. Sometimes the exact condition ('asthma') is known, and sometimes it is less precise ('some sort of cancer'). Equally, sometimes the person can be identified ('my aunt Agatha') and sometimes all that is known is that the person was an uncle. \r\n\r\nThis resource represents a simple structure used to capture an 'elementary' family history. However, it can also be the basis for capturing a more rigorous history useful for genetic and other analysis - refer to the Genetic Pedigree profile for an example.\r\n\r\nThe entire family history for an individual is stored in a single resource.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "FamilyHistory",
"publish": true,
"element": [
{
"path": "FamilyHistory",
"definition": {
"short": "Information about patient's relatives, relevant for patient",
"formal": "Significant health events and conditions for people related to the subject relevant in the context of care for the subject.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Observation[classCode=OBS, moodCode=EVN]"
},
{
"identity": "v2",
"map": "Not in scope for v2"
}
]
}
},
{
"path": "FamilyHistory.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "FamilyHistory.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "FamilyHistory.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "FamilyHistory.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "FamilyHistory.identifier",
"definition": {
"short": "External Id(s) for this record",
"formal": "This records identifiers associated with this family history record that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "id"
}
]
}
},
{
"path": "FamilyHistory.subject",
"definition": {
"short": "Patient history is about",
"formal": "The person who this history concerns.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "participation[typeCode=SBJ].role"
}
]
}
},
{
"path": "FamilyHistory.note",
"definition": {
"short": "Additional details not covered elsewhere",
"formal": "Conveys information about family history not specific to individual relations.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value"
}
]
}
},
{
"path": "FamilyHistory.relation",
"definition": {
"short": "Relative described by history",
"formal": "The related person. Each FamilyHistory resource contains the entire family history for a single person.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "participation[typeCode=SBJ].role[classCode=PAT].player[classCode<LIV, moodCode=INSTANCE].scopedRole"
}
]
}
},
{
"path": "FamilyHistory.relation.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "FamilyHistory.relation.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "FamilyHistory.relation.name",
"definition": {
"short": "The family member described",
"formal": "This will either be a name or a description. E.g. \"Aunt Susan\", \"my cousin with the red hair\".",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "name"
}
]
}
},
{
"path": "FamilyHistory.relation.relationship",
"definition": {
"short": "Relationship to the subject",
"formal": "The type of relationship this person has to the patient (father, mother, brother etc.).",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "FamilialRelationship",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/v3/vs/FamilyMember"
}
},
"mapping": [
{
"identity": "rim",
"map": "code"
}
]
}
},
{
"path": "FamilyHistory.relation.born[x]",
"definition": {
"short": "(approximate) date of birth",
"formal": "The actual or approximate date of birth of the relative.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
},
{
"code": "date"
},
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "player[classCode=LIV, determinerCode=INSTANCE]. birthDate (could be URG)"
}
]
}
},
{
"path": "FamilyHistory.relation.deceased[x]",
"definition": {
"short": "Dead? How old/when?",
"formal": "If this resource is indicating that the related person is deceased, then an indicator of whether the person is deceased (yes) or not (no) or the age or age range or description of age at death - can be indicated here. If the reason for death is known, then it can be indicated in the outcome code of the condition - in this case the deceased property should still be set.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
},
{
"code": "Age"
},
{
"code": "Range"
},
{
"code": "date"
},
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "player[classCode=LIV, determinerCode=INSTANCE].deceasedInd, deceasedDate (could be URG)\n\nFor age, you'd hang an observation off the role"
}
]
}
},
{
"path": "FamilyHistory.relation.note",
"definition": {
"short": "General note about related person",
"formal": "This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value"
}
]
}
},
{
"path": "FamilyHistory.relation.condition",
"definition": {
"short": "Condition that the related person had",
"formal": "The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION, value<Diagnosis]"
}
]
}
},
{
"path": "FamilyHistory.relation.condition.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "FamilyHistory.relation.condition.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "FamilyHistory.relation.condition.type",
"definition": {
"short": "Condition suffered by relation",
"formal": "The actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like 'cancer' depending on how much is known about the condition and the capabilities of the creating system.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".value"
}
]
}
},
{
"path": "FamilyHistory.relation.condition.outcome",
"definition": {
"short": "deceased | permanent disability | etc.",
"formal": "Indicates what happened as a result of this condition. If the condition resulted in death, deceased date is captured on the relation.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ConditionOutcome",
"isExtensible": true,
"conformance": "preferred",
"description": "The result of the condition for the patient. E.g. death, permanent disability, temporary disability, etc."
},
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=OUTC)].target[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION].value"
}
]
}
},
{
"path": "FamilyHistory.relation.condition.onset[x]",
"definition": {
"short": "When condition first manifested",
"formal": "Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.",
"min": 0,
"max": "1",
"type": [
{
"code": "Age"
},
{
"code": "Range"
},
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"Subject Age at measurement\", value<Diagnosis].value[@xsi:typeCode='TS' or 'IVL_TS']\n\nUse originalText for string"
}
]
}
},
{
"path": "FamilyHistory.relation.condition.note",
"definition": {
"short": "Extra information about condition",
"formal": "An area where general notes can be placed about this specific condition.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "subject",
"type": "reference",
"documentation": "The identity of a subject to list family history items for",
"xpath": "f:FamilyHistory/f:subject"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"Significant health events and conditions for people related to the subject relevant in the context of care for the subject.\" class=\"dict\" href=\"familyhistory-definitions.html#FamilyHistory\"><b>FamilyHistory</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"This records identifiers associated with this family history record that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).\" class=\"dict\" href=\"familyhistory-definitions.html#FamilyHistory.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">External Id(s) for this record<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"The person who this history concerns.\" class=\"dict\" href=\"familyhistory-definitions.html#FamilyHistory.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Patient history is about<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"Conveys information about family history not specific to individual relations.\" class=\"dict\" href=\"familyhistory-definitions.html#FamilyHistory.note\"><b>note</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Additional details not covered elsewhere</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The related person. Each FamilyHistory resource contains the entire family history for a single person.\" class=\"dict\" href=\"familyhistory-definitions.html#FamilyHistory.relation\"><b>relation</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Relative described by history --></span>\r\n <<a title=\"This will either be a name or a description. E.g. "Aunt Susan", "my cousin with the red hair".\" class=\"dict\" href=\"familyhistory-definitions.html#FamilyHistory.relation.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">The family member described<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The type of relationship this person has to the patient (father, mother, brother etc.).\" class=\"dict\" href=\"familyhistory-definitions.html#FamilyHistory.relation.relationship\"><b>relationship</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v3/vs/FamilyMember/index.html\">Relationship to the subject<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a><span style=\"color: Gray\"> --></span></relationship>\r\n <<a title=\"The actual or approximate date of birth of the relative.\" class=\"dict\" href=\"familyhistory-definitions.html#FamilyHistory.relation.born_x_\"><b>born[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a>|<a href=\"datatypes.html#date\">date</a>|<a href=\"datatypes.html#string\">string</a></span> <span style=\"color: navy\">(approximate) date of birth</span><span style=\"color: Gray\"> --></span></born[x]>\r\n <<a title=\"If this resource is indicating that the related person is deceased, then an indicator of whether the person is deceased (yes) or not (no) or the age or age range or description of age at death - can be indicated here. If the reason for death is known, then it can be indicated in the outcome code of the condition - in this case the deceased property should still be set.\" class=\"dict\" href=\"familyhistory-definitions.html#FamilyHistory.relation.deceased_x_\"><b>deceased[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a>|<a href=\"datatypes.html#Age\">Age</a>|<a href=\"datatypes.html#Range\">Range</a>|<a href=\"datatypes.html#date\">date</a>|<a href=\"datatypes.html#string\">string</a></span> <span style=\"color: navy\">Dead? How old/when?</span><span style=\"color: Gray\"> --></span></deceased[x]>\r\n <<a title=\"This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.\" class=\"dict\" href=\"familyhistory-definitions.html#FamilyHistory.relation.note\"><b>note</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">General note about related person</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.\" class=\"dict\" href=\"familyhistory-definitions.html#FamilyHistory.relation.condition\"><b>condition</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Condition that the related person had --></span>\r\n <<a title=\"The actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like 'cancer' depending on how much is known about the condition and the capabilities of the creating system.\" class=\"dict\" href=\"familyhistory-definitions.html#FamilyHistory.relation.condition.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Condition suffered by relation</span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"Indicates what happened as a result of this condition. If the condition resulted in death, deceased date is captured on the relation.\" class=\"dict\" href=\"familyhistory-definitions.html#FamilyHistory.relation.condition.outcome\"><b>outcome</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">deceased | permanent disability | etc.</span><span style=\"color: Gray\"> --></span></outcome>\r\n <<a title=\"Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.\" class=\"dict\" href=\"familyhistory-definitions.html#FamilyHistory.relation.condition.onset_x_\"><b>onset[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Age\">Age</a>|<a href=\"datatypes.html#Range\">Range</a>|<a href=\"datatypes.html#string\">string</a></span> <span style=\"color: navy\">When condition first manifested</span><span style=\"color: Gray\"> --></span></onset[x]>\r\n <<a title=\"An area where general notes can be placed about this specific condition.\" class=\"dict\" href=\"familyhistory-definitions.html#FamilyHistory.relation.condition.note\"><b>note</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Extra information about condition</span><span style=\"color: Gray\"> --></span>\r\n </condition>\r\n </relation>\r\n</FamilyHistory>\r\n</pre></div>"
},
{
"title": "\"group\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/group",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/group.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively and are not formally or legally recognized. I.e. A collection of entities that isn't an Organization.\" class=\"dict\" href=\"group-definitions.html#Group\"><b>Group</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"A unique business identifier for this group.\" class=\"dict\" href=\"group-definitions.html#Group.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Unique id<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Identifies the broad classification of the kind of resources the group includes.\" class=\"dict\" href=\"group-definitions.html#Group.type\"><b>type</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"group-type.html\">person | animal | practitioner | device | medication | substance<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.\" class=\"dict\" href=\"group-definitions.html#Group.actual\"><b>actual</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: Can only have members if group is "actual"\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 1..1</b></span> <span style=\"color: navy\">Descriptive or actual<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Provides a specific type of resource the group includes. E.g. "cow", "syringe", etc.\" class=\"dict\" href=\"group-definitions.html#Group.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Kind of Group members<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"A label assigned to the group for human identification and communication.\" class=\"dict\" href=\"group-definitions.html#Group.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Label for Group<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A count of the number of resource instances that are part of the group.\" class=\"dict\" href=\"group-definitions.html#Group.quantity\"><b>quantity</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Number of members<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identifies the traits shared by members of the group.\" class=\"dict\" href=\"group-definitions.html#Group.characteristic\"><b>characteristic</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Trait of group members --></span>\r\n <<a title=\"A code that identifies the kind of trait being asserted.\" class=\"dict\" href=\"group-definitions.html#Group.characteristic.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Kind of characteristic</span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"The value of the trait that holds (or does not hold - see 'exclude') for members of the group.\" class=\"dict\" href=\"group-definitions.html#Group.characteristic.value_x_\"><b>value[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a>|<a href=\"datatypes.html#boolean\">boolean</a>|<a href=\"datatypes.html#Quantity\">Quantity</a>|<a href=\"datatypes.html#Range\">Range</a></span> <span style=\"color: navy\">Value held by characteristic</span><span style=\"color: Gray\"> --></span></value[x]>\r\n <<a title=\"If true, indicates the characteristic is one that is NOT held by members of the group (this element modifies the meaning of other elements)\" class=\"dict\" href=\"group-definitions.html#Group.characteristic.exclude\"><span style=\"text-decoration: underline\"><b>exclude</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Group includes or excludes</span><span style=\"color: Gray\"> --></span>\r\n </characteristic>\r\n <<a title=\"Identifies the resource instances that are members of the group.\" class=\"dict\" href=\"group-definitions.html#Group.member\"><b>member</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: Can only have members if group is "actual"\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"device.html#Device\">Device</a>|<a href=\"medication.html#Medication\">Medication</a>|<a href=\"substance.html#Substance\">Substance</a>)</span> <span style=\"color: navy\">Who is in group</span><span style=\"color: Gray\"> --></span></member>\r\n</Group>\r\n</pre></div>"
},
"name": "group",
"publisher": "FHIR Project",
"description": "Basic Profile. Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively and are not formally or legally recognized. I.e. A collection of entities that isn't an Organization.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage Use Cases The group resource is used in one of two ways:\r\n\r\n* To define a group of specific people, animals, devices, etc. that is being tracked, examined or otherwise referenced as part of healthcare-related activities\r\n* To define a set of *possible* people, animals, devices, etc. that are of interest for some intended future healthcare-related activities\r\nExamples of the former could include group therapy or treatment sessions, exposed entities tracked as part of public health, etc. The latter might be used to define expected subjects for a clinical study.\r\n\r\nBoth use cases are handled by a single resource because the data elements captured tend to be similar.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"structure": [
{
"type": "Group",
"publish": true,
"element": [
{
"path": "Group",
"definition": {
"short": "Group of multiple entities",
"formal": "Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively and are not formally or legally recognized. I.e. A collection of entities that isn't an Organization.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"constraint": [
{
"key": "1",
"name": "No members for non-actual",
"severity": "error",
"human": "Can only have members if group is \"actual\"",
"xpath": "f:actual/@value='true' or not(exists(f:member))"
},
{
"key": "4",
"name": "No more members than quantity",
"severity": "error",
"human": "Can't have more members associated with the group than the value specified for \"quantity\"",
"xpath": "not(f:quantity) or not(f:member) or not(f:quantity>count(f:member))"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Entity[determinerCode=\"GRP\" or determinerCode=\"GRP_KIND\"]"
}
]
}
},
{
"path": "Group.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Group.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Group.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "Group.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "Group.identifier",
"definition": {
"short": "Unique id",
"formal": "A unique business identifier for this group.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "unique(./id[displayable=\"true\" and scope=\"OBJ\"])"
}
]
}
},
{
"path": "Group.type",
"definition": {
"short": "person | animal | practitioner | device | medication | substance",
"formal": "Identifies the broad classification of the kind of resources the group includes.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "GroupType",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/group-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "person: ./classCode=\"PSN\"\n\nanimal: ./classCode=\"ANM\"\n\ndevice: ./classCode=\"DEV\"\n\nmedication: ./classCode=\"MMAT\" and ./playedRole[isNormalRole() and classCode=\"THER\"]\n\nfood: ./classCode=\"FOOD\""
}
]
}
},
{
"path": "Group.actual",
"definition": {
"short": "Descriptive or actual",
"formal": "If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "true: ./determinerCode=\"GRP\"\n\nfalse: ./determinerCode=\"GRP_KIND\""
}
]
}
},
{
"path": "Group.code",
"definition": {
"short": "Kind of Group members",
"formal": "Provides a specific type of resource the group includes. E.g. \"cow\", \"syringe\", etc.",
"comments": "This would generally be omitted for Person resources.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "GroupKind",
"isExtensible": true,
"conformance": "preferred",
"description": "Kind of particular resource. E.g. cow, syringe, lake, etc."
},
"mapping": [
{
"identity": "rim",
"map": "./code"
}
]
}
},
{
"path": "Group.name",
"definition": {
"short": "Label for Group",
"formal": "A label assigned to the group for human identification and communication.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./name[type=\"ST\"]"
}
]
}
},
{
"path": "Group.quantity",
"definition": {
"short": "Number of members",
"formal": "A count of the number of resource instances that are part of the group.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./quantity"
}
]
}
},
{
"path": "Group.characteristic",
"definition": {
"short": "Trait of group members",
"formal": "Identifies the traits shared by members of the group.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./playedRole[isNormalRole()]/participation[isNormalParticipation() and typeCode=\"SBJ\"]/act[isNormalAct and classCode=\"OBS\" and moodCode=\"EVN\"]"
}
]
}
},
{
"path": "Group.characteristic.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Group.characteristic.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Group.characteristic.code",
"definition": {
"short": "Kind of characteristic",
"formal": "A code that identifies the kind of trait being asserted.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "GroupCharacteristicKind",
"isExtensible": true,
"conformance": "preferred",
"description": "List of characteristics used to describe group members. E.g. gender, age, owner, location, etc."
},
"mapping": [
{
"identity": "rim",
"map": "./code"
}
]
}
},
{
"path": "Group.characteristic.value[x]",
"definition": {
"short": "Value held by characteristic",
"formal": "The value of the trait that holds (or does not hold - see 'exclude') for members of the group.",
"comments": "For Range, it means members of the group have a value that falls somewhere within the specified range.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "boolean"
},
{
"code": "Quantity"
},
{
"code": "Range"
}
],
"isModifier": false,
"binding": {
"name": "GroupCharacteristicValue",
"isExtensible": true,
"conformance": "preferred",
"description": "Value of descriptive member characteristic. E.g. red, male, pneumonia, caucasian, etc."
},
"mapping": [
{
"identity": "rim",
"map": "./value"
}
]
}
},
{
"path": "Group.characteristic.exclude",
"definition": {
"short": "Group includes or excludes",
"formal": "If true, indicates the characteristic is one that is NOT held by members of the group.",
"comments": "This is labeled as \"Is Modifier\" because applications cannot wrongly include excluded members as included or vice versa.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "./valueNegationInd"
}
]
}
},
{
"path": "Group.member",
"definition": {
"short": "Who is in group",
"formal": "Identifies the resource instances that are members of the group.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Medication"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Substance"
}
],
"constraint": [
{
"key": "3",
"name": "Group member type agreement",
"severity": "error",
"human": "Member resource types SHALL agree with group type",
"xpath": "lower-case(f:type/@value)=parent::f:Group/f:type/@value or (f:type/@value='Patient' and parent::f:Group/f:type/@value=('animal','person'))"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./scopedRole[isNormalRole() and classCode=\"MBR\"]/player"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "actual",
"type": "token",
"documentation": "Descriptive or actual",
"xpath": "f:Group/f:actual"
},
{
"name": "characteristic",
"type": "token",
"documentation": "Kind of characteristic",
"xpath": "f:Group/f:characteristic/f:code"
},
{
"name": "characteristic-value",
"type": "composite",
"documentation": "A composite of both characteristic and value"
},
{
"name": "code",
"type": "token",
"documentation": "The kind of resources contained",
"xpath": "f:Group/f:code"
},
{
"name": "exclude",
"type": "token",
"documentation": "Group includes or excludes",
"xpath": "f:Group/f:characteristic/f:exclude"
},
{
"name": "identifier",
"type": "token",
"documentation": "Unique id",
"xpath": "f:Group/f:identifier"
},
{
"name": "member",
"type": "reference",
"documentation": "Who is in group",
"xpath": "f:Group/f:member"
},
{
"name": "type",
"type": "token",
"documentation": "The type of resources the group contains",
"xpath": "f:Group/f:type"
},
{
"name": "value",
"type": "token",
"documentation": "Value held by characteristic",
"xpath": "f:Group/f:characteristic/f:value[x]"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively and are not formally or legally recognized. I.e. A collection of entities that isn't an Organization.\" class=\"dict\" href=\"group-definitions.html#Group\"><b>Group</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"A unique business identifier for this group.\" class=\"dict\" href=\"group-definitions.html#Group.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Unique id<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Identifies the broad classification of the kind of resources the group includes.\" class=\"dict\" href=\"group-definitions.html#Group.type\"><b>type</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"group-type.html\">person | animal | practitioner | device | medication | substance<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.\" class=\"dict\" href=\"group-definitions.html#Group.actual\"><b>actual</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: Can only have members if group is "actual"\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 1..1</b></span> <span style=\"color: navy\">Descriptive or actual<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Provides a specific type of resource the group includes. E.g. "cow", "syringe", etc.\" class=\"dict\" href=\"group-definitions.html#Group.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Kind of Group members<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"A label assigned to the group for human identification and communication.\" class=\"dict\" href=\"group-definitions.html#Group.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Label for Group<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A count of the number of resource instances that are part of the group.\" class=\"dict\" href=\"group-definitions.html#Group.quantity\"><b>quantity</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Number of members<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identifies the traits shared by members of the group.\" class=\"dict\" href=\"group-definitions.html#Group.characteristic\"><b>characteristic</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Trait of group members --></span>\r\n <<a title=\"A code that identifies the kind of trait being asserted.\" class=\"dict\" href=\"group-definitions.html#Group.characteristic.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Kind of characteristic</span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"The value of the trait that holds (or does not hold - see 'exclude') for members of the group.\" class=\"dict\" href=\"group-definitions.html#Group.characteristic.value_x_\"><b>value[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a>|<a href=\"datatypes.html#boolean\">boolean</a>|<a href=\"datatypes.html#Quantity\">Quantity</a>|<a href=\"datatypes.html#Range\">Range</a></span> <span style=\"color: navy\">Value held by characteristic</span><span style=\"color: Gray\"> --></span></value[x]>\r\n <<a title=\"If true, indicates the characteristic is one that is NOT held by members of the group (this element modifies the meaning of other elements)\" class=\"dict\" href=\"group-definitions.html#Group.characteristic.exclude\"><span style=\"text-decoration: underline\"><b>exclude</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Group includes or excludes</span><span style=\"color: Gray\"> --></span>\r\n </characteristic>\r\n <<a title=\"Identifies the resource instances that are members of the group.\" class=\"dict\" href=\"group-definitions.html#Group.member\"><b>member</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: Can only have members if group is "actual"\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"device.html#Device\">Device</a>|<a href=\"medication.html#Medication\">Medication</a>|<a href=\"substance.html#Substance\">Substance</a>)</span> <span style=\"color: navy\">Who is in group</span><span style=\"color: Gray\"> --></span></member>\r\n</Group>\r\n</pre></div>"
},
{
"title": "\"imagingstudy\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/imagingstudy",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/imagingstudy.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"Manifest of a set of images produced in study. The set of images may include every image in the study, or it may be an incomplete sample, such as a list of key images.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy\"><b>ImagingStudy</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Date and Time the study took place.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.dateTime\"><b>dateTime</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When the study was performed</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Who the images are of.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Who the images are of</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"Formal identifier for the study.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.uid\"><b>uid</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#oid\">oid</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Formal identifier for the study (0020,000D)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Accession Number.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.accessionNo\"><b>accessionNo</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Accession Number (0008,0050)</span><span style=\"color: Gray\"> --></span></accessionNo>\r\n <<a title=\"Other identifiers for the study.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Other identifiers for the study (0020,0010)</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"A list of the diagnostic orders that resulted in this imaging study being performed.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.order\"><b>order</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"diagnosticorder.html#DiagnosticOrder\">DiagnosticOrder</a>)</span> <span style=\"color: navy\">Order(s) that caused this study to be performed</span><span style=\"color: Gray\"> --></span></order>\r\n <<a title=\"A list of all the Series.ImageModality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19).\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.modality\"><b>modality</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"imaging-modality.html\">All series.modality if actual acquisition modalities</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The requesting/referring physician.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.referrer\"><b>referrer</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">Referring physician (0008,0090)</span><span style=\"color: Gray\"> --></span></referrer>\r\n <<a title=\"Availability of study (online, offline or nearline).\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.availability\"><b>availability</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"instance-availability.html\">ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056)</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"WADO-RS URI where Study is available.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.url\"><b>url</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Retrieve URI (0008,1190)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Number of Series in Study.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.numberOfSeries\"><b>numberOfSeries</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Number of Study Related Series (0020,1206)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Number of SOP Instances in Study.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.numberOfInstances\"><b>numberOfInstances</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Number of Study Related Instances (0020,1208)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Diagnoses etc provided with request.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.clinicalInformation\"><b>clinicalInformation</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Diagnoses etc with request (0040,1002)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Type of procedure performed.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.procedure\"><b>procedure</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Coding\">Coding</a></span> <span style=\"color: navy\">Type of procedure performed (0008,1032)</span><span style=\"color: Gray\"> --></span></procedure>\r\n <<a title=\"Who read study and interpreted the images.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.interpreter\"><b>interpreter</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">Who interpreted images (0008,1060)</span><span style=\"color: Gray\"> --></span></interpreter>\r\n <<a title=\"Institution-generated description or classification of the Study (component) performed.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Institution-generated description (0008,1030)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Each study has one or more series of image instances.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series\"><b>series</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Each study has one or more series of instances --></span>\r\n <<a title=\"The number of this series in the overall sequence.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series.number\"><b>number</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Number of this series in overall sequence (0020,0011)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The modality of this series sequence.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series.modality\"><b>modality</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"modality.html\">The modality of the instances in the series (0008,0060)</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Formal identifier for this series.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series.uid\"><b>uid</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#oid\">oid</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Formal identifier for this series (0020,000E)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A description of the series.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">A description of the series (0008,103E)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Sequence that contains attributes from the.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series.numberOfInstances\"><b>numberOfInstances</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Number of Series Related Instances (0020,1209)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Availability of series (online, offline or nearline).\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series.availability\"><b>availability</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"instance-availability.html\">ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056)</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"WADO-RS URI where Series is available.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series.url\"><b>url</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Retrieve URI (0008,1115 > 0008,1190)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Body part examined. See DICOM Part 16 Annex L for the mapping from DICOM to Snomed.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series.bodySite\"><b>bodySite</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Coding\">Coding</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-body-site.html\">Body part examined (Map from 0018,0015)</a></span><span style=\"color: Gray\"> --></span></bodySite>\r\n <<a title=\"When the series started.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series.dateTime\"><b>dateTime</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When the series started</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A single image taken from a patient.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series.instance\"><b>instance</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..*</b></span> A single instance taken from a patient (image or other) --></span>\r\n <<a title=\"The number of this image in the series.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series.instance.number\"><b>number</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">The number of this instance in the series (0020,0013)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Formal identifier for this image.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series.instance.uid\"><b>uid</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#oid\">oid</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Formal identifier for this instance (0008,0018)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"DICOM Image type.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series.instance.sopclass\"><b>sopclass</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#oid\">oid</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">DICOM class type (0008,0016)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Type of instance (image etc) (0004,1430).\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series.instance.type\"><b>type</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Type of instance (image etc) (0004,1430)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Description (0070,0080 | 0040,A043 > 0008,0104 | 0042,0010 | 0008,0008).\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series.instance.title\"><b>title</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Description (0070,0080 | 0040,A043 > 0008,0104 | 0042,0010 | 0008,0008)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"WADO-RS url where image is available.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series.instance.url\"><b>url</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">WADO-RS service where instance is available (0008,1199 > 0008,1190)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A FHIR resource with content for this instance.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series.instance.attachment\"><b>attachment</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">A FHIR resource with content for this instance</span><span style=\"color: Gray\"> --></span></attachment>\r\n </instance>\r\n </series>\r\n</ImagingStudy>\r\n</pre></div>"
},
"name": "imagingstudy",
"publisher": "FHIR Project",
"description": "Basic Profile. Manifest of a set of images produced in study. The set of images may include every image in the study, or it may be an incomplete sample, such as a list of key images.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage This resource summarizes a series of images or other instances generated as part of an imaging study, and provides references to where the images are available using WADO-RS. This resource is used to make information concerning images etc. that are available in other clinical contexts such as diagnostic reports, Care Plans, etc. Also, see the use case description below. \r\n\r\nThis resources has been specifically designed with use in DICOM contexts in mind. The content is closely based on the definitions of the equivalent DICOM constructs, and informed by usage patterns already established through DICOM implementation practices, including XDS-I. It is not, however, necessary to use DICOM infrastructure in order to use this resource.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "dicom",
"uri": "http://nema.org/dicom",
"name": "DICOM"
}
],
"structure": [
{
"type": "ImagingStudy",
"publish": true,
"element": [
{
"path": "ImagingStudy",
"definition": {
"short": "A set of images produced in single study (one or more series of references images)",
"formal": "Manifest of a set of images produced in study. The set of images may include every image in the study, or it may be an incomplete sample, such as a list of key images.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Act[classCode=COMPOSITION, moodCode=EVN]"
},
{
"identity": "dicom",
"map": "Reference IHE radiology TF vol 2 table 4.14.1"
}
]
}
},
{
"path": "ImagingStudy.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ImagingStudy.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ImagingStudy.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "ImagingStudy.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "ImagingStudy.dateTime",
"definition": {
"short": "When the study was performed",
"formal": "Date and Time the study took place.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "dicom",
"map": "0008,0020+0008,0030"
}
]
}
},
{
"path": "ImagingStudy.subject",
"definition": {
"short": "Who the images are of",
"formal": "Who the images are of.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
},
{
"identity": "dicom",
"map": "0010/*"
}
]
}
},
{
"path": "ImagingStudy.uid",
"definition": {
"short": "Formal identifier for the study (0020,000D)",
"formal": "Formal identifier for the study.",
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "dicom",
"map": "0020,000D"
}
]
}
},
{
"path": "ImagingStudy.accessionNo",
"definition": {
"short": "Accession Number (0008,0050)",
"formal": "Accession Number.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=ACSN, moodCode=EVN].id"
},
{
"identity": "dicom",
"map": "0008,0050"
}
]
}
},
{
"path": "ImagingStudy.identifier",
"definition": {
"short": "Other identifiers for the study (0020,0010)",
"formal": "Other identifiers for the study.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id (no means to distinguish from uid)"
},
{
"identity": "dicom",
"map": "0020,0010"
}
]
}
},
{
"path": "ImagingStudy.order",
"definition": {
"short": "Order(s) that caused this study to be performed",
"formal": "A list of the diagnostic orders that resulted in this imaging study being performed.",
"comments": "The order(s) can be inferred from information such as accession numbers, but the details of this depend on local workflow management. \nNote that there is a many-many relationship between orders and studies.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/DiagnosticOrder"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=FLFS].target[classCode=DGIMG, moodCode=RQO]"
}
]
}
},
{
"path": "ImagingStudy.modality",
"definition": {
"short": "All series.modality if actual acquisition modalities",
"formal": "A list of all the Series.ImageModality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19).",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "ImagingModality",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/imaging-modality"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "dicom",
"map": "0008,0061"
}
]
}
},
{
"path": "ImagingStudy.referrer",
"definition": {
"short": "Referring physician (0008,0090)",
"formal": "The requesting/referring physician.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=FLFS].target[classCode=DGIMG, moodCode=RQO].participation[typeCode=AUT].role"
},
{
"identity": "dicom",
"map": "0008,0090"
}
]
}
},
{
"path": "ImagingStudy.availability",
"definition": {
"short": "ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056)",
"formal": "Availability of study (online, offline or nearline).",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "InstanceAvailability",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/instance-availability"
}
},
"mapping": [
{
"identity": "rim",
"map": "Not supported"
},
{
"identity": "dicom",
"map": "0008,0056"
}
]
}
},
{
"path": "ImagingStudy.url",
"definition": {
"short": "Retrieve URI (0008,1190)",
"formal": "WADO-RS URI where Study is available.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".text.reference"
},
{
"identity": "dicom",
"map": "0008,1190"
}
]
}
},
{
"path": "ImagingStudy.numberOfSeries",
"definition": {
"short": "Number of Study Related Series (0020,1206)",
"formal": "Number of Series in Study.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=OBSSER, moodCode=EVN].repeatNumber"
},
{
"identity": "dicom",
"map": "(0020,1206)"
}
]
}
},
{
"path": "ImagingStudy.numberOfInstances",
"definition": {
"short": "Number of Study Related Instances (0020,1208)",
"formal": "Number of SOP Instances in Study.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=DGIMG, moodCode=EVN].repeatNumber"
},
{
"identity": "dicom",
"map": "(0020,1208)"
}
]
}
},
{
"path": "ImagingStudy.clinicalInformation",
"definition": {
"short": "Diagnoses etc with request (0040,1002)",
"formal": "Diagnoses etc provided with request.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=PERT].target"
},
{
"identity": "dicom",
"map": "0040,1002, 0008,1080"
}
]
}
},
{
"path": "ImagingStudy.procedure",
"definition": {
"short": "Type of procedure performed (0008,1032)",
"formal": "Type of procedure performed.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=PROC, moodCode=EVN]"
},
{
"identity": "dicom",
"map": "0008,1032"
}
]
}
},
{
"path": "ImagingStudy.interpreter",
"definition": {
"short": "Who interpreted images (0008,1060)",
"formal": "Who read study and interpreted the images.",
"comments": "or is this 4008,010C?.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PRF].role"
},
{
"identity": "dicom",
"map": "0008,1060"
}
]
}
},
{
"path": "ImagingStudy.description",
"definition": {
"short": "Institution-generated description (0008,1030)",
"formal": "Institution-generated description or classification of the Study (component) performed.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".text"
},
{
"identity": "dicom",
"map": "0008,1030"
}
]
}
},
{
"path": "ImagingStudy.series",
"definition": {
"short": "Each study has one or more series of instances",
"formal": "Each study has one or more series of image instances.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=OBSSER, moodCode=EVN]"
}
]
}
},
{
"path": "ImagingStudy.series.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ImagingStudy.series.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ImagingStudy.series.number",
"definition": {
"short": "Number of this series in overall sequence (0020,0011)",
"formal": "The number of this series in the overall sequence.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[type=COMP, source[classCode=COMPOSITION, moodCode=EVN]].sequenceNumber"
},
{
"identity": "dicom",
"map": "0020,0011"
}
]
}
},
{
"path": "ImagingStudy.series.modality",
"definition": {
"short": "The modality of the instances in the series (0008,0060)",
"formal": "The modality of this series sequence.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "Modality",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/modality"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "dicom",
"map": "0008,0060"
}
]
}
},
{
"path": "ImagingStudy.series.uid",
"definition": {
"short": "Formal identifier for this series (0020,000E)",
"formal": "Formal identifier for this series.",
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "dicom",
"map": "0020,000E"
}
]
}
},
{
"path": "ImagingStudy.series.description",
"definition": {
"short": "A description of the series (0008,103E)",
"formal": "A description of the series.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".text"
},
{
"identity": "dicom",
"map": "0008,103E"
}
]
}
},
{
"path": "ImagingStudy.series.numberOfInstances",
"definition": {
"short": "Number of Series Related Instances (0020,1209)",
"formal": "Sequence that contains attributes from the.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=DGIMG, moodCode=EVN].repeatNumber"
},
{
"identity": "dicom",
"map": "0020,1209"
}
]
}
},
{
"path": "ImagingStudy.series.availability",
"definition": {
"short": "ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056)",
"formal": "Availability of series (online, offline or nearline).",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "InstanceAvailability",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/instance-availability"
}
},
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP]. source[classCode=OBS, moodCode=EVN, code=\"availability\"].value"
},
{
"identity": "dicom",
"map": "0008,0056"
}
]
}
},
{
"path": "ImagingStudy.series.url",
"definition": {
"short": "Retrieve URI (0008,1115 > 0008,1190)",
"formal": "WADO-RS URI where Series is available.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".text.reference"
},
{
"identity": "dicom",
"map": "0008,1115 > 0008,1190"
}
]
}
},
{
"path": "ImagingStudy.series.bodySite",
"definition": {
"short": "Body part examined (Map from 0018,0015)",
"formal": "Body part examined. See DICOM Part 16 Annex L for the mapping from DICOM to Snomed.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isModifier": false,
"binding": {
"name": "BodySite",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/body-site"
}
},
"mapping": [
{
"identity": "rim",
"map": ".targetSiteCode"
},
{
"identity": "dicom",
"map": "0018,0015"
}
]
}
},
{
"path": "ImagingStudy.series.dateTime",
"definition": {
"short": "When the series started",
"formal": "When the series started.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
}
},
{
"path": "ImagingStudy.series.instance",
"definition": {
"short": "A single instance taken from a patient (image or other)",
"formal": "A single image taken from a patient.",
"min": 1,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=DGIMG, moodCode=EVN]"
}
]
}
},
{
"path": "ImagingStudy.series.instance.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ImagingStudy.series.instance.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ImagingStudy.series.instance.number",
"definition": {
"short": "The number of this instance in the series (0020,0013)",
"formal": "The number of this image in the series.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP, source[classCode=OBSSER, moodCode=EVN]].sequenceNumber"
},
{
"identity": "dicom",
"map": "0020,0013"
}
]
}
},
{
"path": "ImagingStudy.series.instance.uid",
"definition": {
"short": "Formal identifier for this instance (0008,0018)",
"formal": "Formal identifier for this image.",
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "dicom",
"map": "0008,0018"
}
]
}
},
{
"path": "ImagingStudy.series.instance.sopclass",
"definition": {
"short": "DICOM class type (0008,0016)",
"formal": "DICOM Image type.",
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP]. source[classCode=OBS, moodCode=EVN, code=\"sop class\"].value"
},
{
"identity": "dicom",
"map": "0008,0016"
}
]
}
},
{
"path": "ImagingStudy.series.instance.type",
"definition": {
"short": "Type of instance (image etc) (0004,1430)",
"formal": "Type of instance (image etc) (0004,1430).",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "dicom",
"map": "0004,1430"
}
]
}
},
{
"path": "ImagingStudy.series.instance.title",
"definition": {
"short": "Description (0070,0080 | 0040,A043 > 0008,0104 | 0042,0010 | 0008,0008)",
"formal": "Description (0070,0080 | 0040,A043 > 0008,0104 | 0042,0010 | 0008,0008).",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".title"
},
{
"identity": "dicom",
"map": "0070,0080 | 0040,A043 > 0008,0104 | 0042,0010 | 0008,0008"
}
]
}
},
{
"path": "ImagingStudy.series.instance.url",
"definition": {
"short": "WADO-RS service where instance is available (0008,1199 > 0008,1190)",
"formal": "WADO-RS url where image is available.",
"comments": "Each instance may have a url and an attachment. Both represent the same information, but using different approaches. The URL is a reference to a WADO-RS service that makes the instance available.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".text.reference"
},
{
"identity": "dicom",
"map": "0008,1199 > 0008,1190"
}
]
}
},
{
"path": "ImagingStudy.series.instance.attachment",
"definition": {
"short": "A FHIR resource with content for this instance",
"formal": "A FHIR resource with content for this instance.",
"comments": "Each instance may have a url and an attachment. Both represent the same information, but using different approaches. The attachment is a reference to a FHIR resource (Media, Document, etc).",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Any"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".text.binary"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "accession",
"type": "token",
"documentation": "The accession id for the image",
"xpath": "f:ImagingStudy/f:accessionNo"
},
{
"name": "bodysite",
"type": "token",
"documentation": "Body part examined (Map from 0018,0015)",
"xpath": "f:ImagingStudy/f:series/f:bodySite"
},
{
"name": "date",
"type": "date",
"documentation": "The date the study was done was taken",
"xpath": "f:ImagingStudy/f:dateTime"
},
{
"name": "dicom-class",
"type": "token",
"documentation": "DICOM class type (0008,0016)",
"xpath": "f:ImagingStudy/f:series/f:instance/f:sopclass"
},
{
"name": "modality",
"type": "token",
"documentation": "The modality of the image",
"xpath": "f:ImagingStudy/f:series/f:modality"
},
{
"name": "series",
"type": "token",
"documentation": "The series id for the image",
"xpath": "f:ImagingStudy/f:series/f:uid"
},
{
"name": "size",
"type": "number",
"documentation": "The size of the image in MB - may include > or < in the value"
},
{
"name": "study",
"type": "token",
"documentation": "The study id for the image",
"xpath": "f:ImagingStudy/f:uid"
},
{
"name": "subject",
"type": "reference",
"documentation": "Who the study is about",
"xpath": "f:ImagingStudy/f:subject"
},
{
"name": "uid",
"type": "token",
"documentation": "Formal identifier for this instance (0008,0018)",
"xpath": "f:ImagingStudy/f:series/f:instance/f:uid"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"Manifest of a set of images produced in study. The set of images may include every image in the study, or it may be an incomplete sample, such as a list of key images.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy\"><b>ImagingStudy</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Date and Time the study took place.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.dateTime\"><b>dateTime</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When the study was performed</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Who the images are of.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Who the images are of</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"Formal identifier for the study.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.uid\"><b>uid</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#oid\">oid</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Formal identifier for the study (0020,000D)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Accession Number.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.accessionNo\"><b>accessionNo</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Accession Number (0008,0050)</span><span style=\"color: Gray\"> --></span></accessionNo>\r\n <<a title=\"Other identifiers for the study.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Other identifiers for the study (0020,0010)</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"A list of the diagnostic orders that resulted in this imaging study being performed.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.order\"><b>order</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"diagnosticorder.html#DiagnosticOrder\">DiagnosticOrder</a>)</span> <span style=\"color: navy\">Order(s) that caused this study to be performed</span><span style=\"color: Gray\"> --></span></order>\r\n <<a title=\"A list of all the Series.ImageModality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19).\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.modality\"><b>modality</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"imaging-modality.html\">All series.modality if actual acquisition modalities</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The requesting/referring physician.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.referrer\"><b>referrer</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">Referring physician (0008,0090)</span><span style=\"color: Gray\"> --></span></referrer>\r\n <<a title=\"Availability of study (online, offline or nearline).\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.availability\"><b>availability</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"instance-availability.html\">ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056)</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"WADO-RS URI where Study is available.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.url\"><b>url</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Retrieve URI (0008,1190)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Number of Series in Study.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.numberOfSeries\"><b>numberOfSeries</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Number of Study Related Series (0020,1206)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Number of SOP Instances in Study.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.numberOfInstances\"><b>numberOfInstances</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Number of Study Related Instances (0020,1208)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Diagnoses etc provided with request.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.clinicalInformation\"><b>clinicalInformation</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Diagnoses etc with request (0040,1002)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Type of procedure performed.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.procedure\"><b>procedure</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Coding\">Coding</a></span> <span style=\"color: navy\">Type of procedure performed (0008,1032)</span><span style=\"color: Gray\"> --></span></procedure>\r\n <<a title=\"Who read study and interpreted the images.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.interpreter\"><b>interpreter</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">Who interpreted images (0008,1060)</span><span style=\"color: Gray\"> --></span></interpreter>\r\n <<a title=\"Institution-generated description or classification of the Study (component) performed.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Institution-generated description (0008,1030)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Each study has one or more series of image instances.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series\"><b>series</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Each study has one or more series of instances --></span>\r\n <<a title=\"The number of this series in the overall sequence.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series.number\"><b>number</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Number of this series in overall sequence (0020,0011)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The modality of this series sequence.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series.modality\"><b>modality</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"modality.html\">The modality of the instances in the series (0008,0060)</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Formal identifier for this series.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series.uid\"><b>uid</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#oid\">oid</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Formal identifier for this series (0020,000E)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A description of the series.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">A description of the series (0008,103E)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Sequence that contains attributes from the.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series.numberOfInstances\"><b>numberOfInstances</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Number of Series Related Instances (0020,1209)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Availability of series (online, offline or nearline).\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series.availability\"><b>availability</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"instance-availability.html\">ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056)</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"WADO-RS URI where Series is available.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series.url\"><b>url</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Retrieve URI (0008,1115 > 0008,1190)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Body part examined. See DICOM Part 16 Annex L for the mapping from DICOM to Snomed.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series.bodySite\"><b>bodySite</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Coding\">Coding</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-body-site.html\">Body part examined (Map from 0018,0015)</a></span><span style=\"color: Gray\"> --></span></bodySite>\r\n <<a title=\"When the series started.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series.dateTime\"><b>dateTime</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When the series started</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A single image taken from a patient.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series.instance\"><b>instance</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..*</b></span> A single instance taken from a patient (image or other) --></span>\r\n <<a title=\"The number of this image in the series.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series.instance.number\"><b>number</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">The number of this instance in the series (0020,0013)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Formal identifier for this image.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series.instance.uid\"><b>uid</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#oid\">oid</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Formal identifier for this instance (0008,0018)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"DICOM Image type.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series.instance.sopclass\"><b>sopclass</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#oid\">oid</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">DICOM class type (0008,0016)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Type of instance (image etc) (0004,1430).\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series.instance.type\"><b>type</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Type of instance (image etc) (0004,1430)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Description (0070,0080 | 0040,A043 > 0008,0104 | 0042,0010 | 0008,0008).\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series.instance.title\"><b>title</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Description (0070,0080 | 0040,A043 > 0008,0104 | 0042,0010 | 0008,0008)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"WADO-RS url where image is available.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series.instance.url\"><b>url</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">WADO-RS service where instance is available (0008,1199 > 0008,1190)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A FHIR resource with content for this instance.\" class=\"dict\" href=\"imagingstudy-definitions.html#ImagingStudy.series.instance.attachment\"><b>attachment</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">A FHIR resource with content for this instance</span><span style=\"color: Gray\"> --></span></attachment>\r\n </instance>\r\n </series>\r\n</ImagingStudy>\r\n</pre></div>"
},
{
"title": "\"immunization\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/immunization",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/immunization.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"Immunization event information.\" class=\"dict\" href=\"immunization-definitions.html#Immunization\"><b>Immunization</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"A unique identifier assigned to this adverse reaction record.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Business identifier</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Date vaccine administered or was to be administered.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.date\"><b>date</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Vaccination administration date</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Vaccine that was administered or was to be administered.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.vaccineType\"><b>vaccineType</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v3/vs/VaccineType/index.html\">Vaccine product administered</a><span style=\"color: Gray\"> --></span></vaccineType>\r\n <<a title=\"The patient to whom the vaccine was to be administered.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Who was immunized?</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"Indicates if the vaccination was refused.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.refusedIndicator\"><b>refusedIndicator</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Was immunization refused?</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"True if this administration was reported rather than directly administered.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.reported\"><b>reported</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Is this a self-reported record?</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Clinician who administered the vaccine.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.performer\"><b>performer</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">Who administered vaccine?</span><span style=\"color: Gray\"> --></span></performer>\r\n <<a title=\"Clinician who ordered the vaccination.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.requester\"><b>requester</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">Who ordered vaccination?</span><span style=\"color: Gray\"> --></span></requester>\r\n <<a title=\"Name of vaccine manufacturer.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.manufacturer\"><b>manufacturer</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">Vaccine manufacturer</span><span style=\"color: Gray\"> --></span></manufacturer>\r\n <<a title=\"The service delivery location where the vaccine administration occurred.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.location\"><b>location</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">Where did vaccination occur?</span><span style=\"color: Gray\"> --></span></location>\r\n <<a title=\"Lot number of the vaccine product.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.lotNumber\"><b>lotNumber</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Vaccine lot number</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Date vaccine batch expires.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.expirationDate\"><b>expirationDate</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#date\">date</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Vaccine expiration date</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Body site where vaccine was administered.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.site\"><b>site</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-immunization-site.html\">Body site vaccine was administered</a></span><span style=\"color: Gray\"> --></span></site>\r\n <<a title=\"The path by which the vaccine product is taken into the body.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.route\"><b>route</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-immunization-route.html\">How vaccine entered body</a></span><span style=\"color: Gray\"> --></span></route>\r\n <<a title=\"The quantity of vaccine product that was administered.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.doseQuantity\"><b>doseQuantity</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">Amount of vaccine administered</span><span style=\"color: Gray\"> --></span></doseQuantity>\r\n <<a title=\"Reasons why a vaccine was administered or refused.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.explanation\"><b>explanation</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> Administration / refusal reasons --></span>\r\n <<a title=\"Reasons why a vaccine was administered.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.explanation.reason\"><b>reason</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-immunization-reason.html\">Why immunization occurred</a></span><span style=\"color: Gray\"> --></span></reason>\r\n <<a title=\"Refusal or exemption reasons.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.explanation.refusalReason\"><b>refusalReason</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-no-immunization-reason.html\">Why immunization did not occur</a></span><span style=\"color: Gray\"> --></span></refusalReason>\r\n </explanation>\r\n <<a title=\"Categorical data indicating that an adverse event is associated in time to an immunization.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.reaction\"><b>reaction</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Details of a reaction that follows immunization --></span>\r\n <<a title=\"Date of reaction to the immunization.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.reaction.date\"><b>date</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When did reaction start?</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Details of the reaction.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.reaction.detail\"><b>detail</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"adversereaction.html#AdverseReaction\">AdverseReaction</a>|<a href=\"observation.html#Observation\">Observation</a>)</span> <span style=\"color: navy\">Additional information on reaction</span><span style=\"color: Gray\"> --></span></detail>\r\n <<a title=\"Self-reported indicator.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.reaction.reported\"><b>reported</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Was reaction self-reported?</span><span style=\"color: Gray\"> --></span>\r\n </reaction>\r\n <<a title=\"Contains information about the protocol(s) under which the vaccine was administered.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.vaccinationProtocol\"><b>vaccinationProtocol</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> What protocol was followed --></span>\r\n <<a title=\"Nominal position in a series.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.vaccinationProtocol.doseSequence\"><b>doseSequence</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">What dose number within series?</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Contains the description about the protocol under which the vaccine was administered.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.vaccinationProtocol.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Details of vaccine protocol</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Indicates the authority who published the protocol? E.g. ACIP.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.vaccinationProtocol.authority\"><b>authority</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">Who is responsible for protocol</span><span style=\"color: Gray\"> --></span></authority>\r\n <<a title=\"One possible path to achieve presumed immunity against a disease - within the context of an authority.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.vaccinationProtocol.series\"><b>series</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Name of vaccine series</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The recommended number of doses to achieve immunity.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.vaccinationProtocol.seriesDoses\"><b>seriesDoses</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Recommended number of doses for immunity</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The targeted disease.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.vaccinationProtocol.doseTarget\"><b>doseTarget</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-vaccination-protocol-dose-target.html\">Disease immunized against</a></span><span style=\"color: Gray\"> --></span></doseTarget>\r\n <<a title=\"Indicates if the immunization event should "count" against the protocol.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.vaccinationProtocol.doseStatus\"><b>doseStatus</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-vaccination-protocol-dose-status.html\">Does dose count towards immunity?</a></span><span style=\"color: Gray\"> --></span></doseStatus>\r\n <<a title=\"Provides an explanation as to why a immunization event should or should not count against the protocol.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.vaccinationProtocol.doseStatusReason\"><b>doseStatusReason</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-vaccination-protocol-dose-status-reason.html\">Why does does count/not count?</a></span><span style=\"color: Gray\"> --></span></doseStatusReason>\r\n </vaccinationProtocol>\r\n</Immunization>\r\n</pre></div>"
},
"name": "immunization",
"publisher": "FHIR Project",
"description": "Basic Profile. Immunization event information.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage The immunization resource is intended to cover the administration of vaccines to patients across all healthcare disciplines in all care settings and all regions. This includes immunization of both humans and animals but does not include the administration of non-vaccine agents, even those that may have or claim immunological effects. \r\n\r\nAdditionally, the immunization resource is expected to cover key concepts related to the creation, revision and querying of a patient's immunization history. This resource - through consultation with the PHER work group - is believed to meet key use cases and information requirements as defined in the existing HL7 v2.x immunization implementation guide, HL7 v3 POIZ domain and Immunization Domain Analysis Model.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
},
{
"identity": "cda",
"uri": "http://hl7.org/v3/cda",
"name": "CDA (R2)"
}
],
"structure": [
{
"type": "Immunization",
"publish": true,
"element": [
{
"path": "Immunization",
"definition": {
"short": "Immunization event information",
"formal": "Immunization event information.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "SubstanceAdministration"
},
{
"identity": "v2",
"map": "VXU_V04"
}
]
}
},
{
"path": "Immunization.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Immunization.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Immunization.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "Immunization.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "Immunization.identifier",
"definition": {
"short": "Business identifier",
"formal": "A unique identifier assigned to this adverse reaction record.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id"
}
]
}
},
{
"path": "Immunization.date",
"definition": {
"short": "Vaccination administration date",
"formal": "Date vaccine administered or was to be administered.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value"
},
{
"identity": "v2",
"map": "RXA-3-date/time start of administration"
}
]
}
},
{
"path": "Immunization.vaccineType",
"definition": {
"short": "Vaccine product administered",
"formal": "Vaccine that was administered or was to be administered.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "VaccineType",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/v3/vs/VaccineType"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code"
},
{
"identity": "v2",
"map": "RXA-5-administered code"
}
]
}
},
{
"path": "Immunization.subject",
"definition": {
"short": "Who was immunized?",
"formal": "The patient to whom the vaccine was to be administered.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".partipication[ttypeCode=].role"
},
{
"identity": "v2",
"map": "PID-3-patient ID list"
}
]
}
},
{
"path": "Immunization.refusedIndicator",
"definition": {
"short": "Was immunization refused?",
"formal": "Indicates if the vaccination was refused.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "[actionNegationInd=true].reasonCode"
}
]
}
},
{
"path": "Immunization.reported",
"definition": {
"short": "Is this a self-reported record?",
"formal": "True if this administration was reported rather than directly administered.",
"comments": "May need source of reported info (e.g. parent), but leave out for now.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)"
},
{
"identity": "v2",
"map": "RXA-9"
}
]
}
},
{
"path": "Immunization.performer",
"definition": {
"short": "Who administered vaccine?",
"formal": "Clinician who administered the vaccine.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PRF].COCT_MT090102UV"
},
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/performer/assignedEntity/assignedPerson/name"
},
{
"identity": "v2",
"map": "RXA-10-administering provider"
}
]
}
},
{
"path": "Immunization.requester",
"definition": {
"short": "Who ordered vaccination?",
"formal": "Clinician who ordered the vaccination.",
"comments": "Other participants - delegate to Provenance resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship.target[classCode=SBADM].participation[typeCode=AUT].COCT_MT090102UV"
},
{
"identity": "v2",
"map": "ORC-12-ordering provider"
}
]
}
},
{
"path": "Immunization.manufacturer",
"definition": {
"short": "Vaccine manufacturer",
"formal": "Name of vaccine manufacturer.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]"
},
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name"
},
{
"identity": "v2",
"map": "RXA-17-substance manufacturer name"
}
]
}
},
{
"path": "Immunization.location",
"definition": {
"short": "Where did vaccination occur?",
"formal": "The service delivery location where the vaccine administration occurred.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Location"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=LOC].COCT_MT240000UV"
},
{
"identity": "v2",
"map": "RXA-27-administered-at (or RXA-11-administered-at location, deprecated as of v2.7)"
}
]
}
},
{
"path": "Immunization.lotNumber",
"definition": {
"short": "Vaccine lot number",
"formal": "Lot number of the vaccine product.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id"
},
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText"
},
{
"identity": "v2",
"map": "RXA-15-substance lot number"
}
]
}
},
{
"path": "Immunization.expirationDate",
"definition": {
"short": "Vaccine expiration date",
"formal": "Date vaccine batch expires.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime"
},
{
"identity": "v2",
"map": "RXA-16-substance expiration date"
}
]
}
},
{
"path": "Immunization.site",
"definition": {
"short": "Body site vaccine was administered",
"formal": "Body site where vaccine was administered.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ImmunizationSite",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/immunization-site"
}
},
"mapping": [
{
"identity": "rim",
"map": "observation.targetSiteCode"
},
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code"
},
{
"identity": "v2",
"map": "RXR-2-administration site"
}
]
}
},
{
"path": "Immunization.route",
"definition": {
"short": "How vaccine entered body",
"formal": "The path by which the vaccine product is taken into the body.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ImmunizationRoute",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/immunization-route"
}
},
"mapping": [
{
"identity": "rim",
"map": ".routeCode"
},
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code"
},
{
"identity": "v2",
"map": "RXR-1-route"
}
]
}
},
{
"path": "Immunization.doseQuantity",
"definition": {
"short": "Amount of vaccine administered",
"formal": "The quantity of vaccine product that was administered.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".doseQuantity"
},
{
"identity": "v2",
"map": "RXA-6-administered amount / RXA-7.1-administered units.code"
}
]
}
},
{
"path": "Immunization.explanation",
"definition": {
"short": "Administration / refusal reasons",
"formal": "Reasons why a vaccine was administered or refused.",
"min": 0,
"max": "1",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
}
},
{
"path": "Immunization.explanation.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Immunization.explanation.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Immunization.explanation.reason",
"definition": {
"short": "Why immunization occurred",
"formal": "Reasons why a vaccine was administered.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ImmunizationReason",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/immunization-reason"
}
},
"mapping": [
{
"identity": "rim",
"map": "[actionNegationInd=false].reasonCode"
}
]
}
},
{
"path": "Immunization.explanation.refusalReason",
"definition": {
"short": "Why immunization did not occur",
"formal": "Refusal or exemption reasons.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "NoImmunizationReason",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/no-immunization-reason"
}
},
"mapping": [
{
"identity": "rim",
"map": "[actionNegationInd=true].reasonCode"
},
{
"identity": "v2",
"map": "RXA-18"
}
]
}
},
{
"path": "Immunization.reaction",
"definition": {
"short": "Details of a reaction that follows immunization",
"formal": "Categorical data indicating that an adverse event is associated in time to an immunization.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Observation[classCode=obs].code"
},
{
"identity": "v2",
"map": "OBX-3"
}
]
}
},
{
"path": "Immunization.reaction.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Immunization.reaction.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Immunization.reaction.date",
"definition": {
"short": "When did reaction start?",
"formal": "Date of reaction to the immunization.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "v2",
"map": "OBX-14 (ideally this would be reported in an IAM segment, but IAM is not part of the V2.x VXU message - most likely would appear in OBX segments if at all\n)"
}
]
}
},
{
"path": "Immunization.reaction.detail",
"definition": {
"short": "Additional information on reaction",
"formal": "Details of the reaction.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/AdverseReaction"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Observation"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".value"
},
{
"identity": "v2",
"map": "OBX-5"
}
]
}
},
{
"path": "Immunization.reaction.reported",
"definition": {
"short": "Was reaction self-reported?",
"formal": "Self-reported indicator.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)"
},
{
"identity": "v2",
"map": "(no such concept seems to exist for allergy/adverse reaction in V2.x)"
}
]
}
},
{
"path": "Immunization.vaccinationProtocol",
"definition": {
"short": "What protocol was followed",
"formal": "Contains information about the protocol(s) under which the vaccine was administered.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM]"
},
{
"identity": "v2",
"map": "(V2.x doesn't seem to provide for this)"
}
]
}
},
{
"path": "Immunization.vaccinationProtocol.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Immunization.vaccinationProtocol.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Immunization.vaccinationProtocol.doseSequence",
"definition": {
"short": "What dose number within series?",
"formal": "Nominal position in a series.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].sequenceNumber"
}
]
}
},
{
"path": "Immunization.vaccinationProtocol.description",
"definition": {
"short": "Details of vaccine protocol",
"formal": "Contains the description about the protocol under which the vaccine was administered.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].text"
}
]
}
},
{
"path": "Immunization.vaccinationProtocol.authority",
"definition": {
"short": "Who is responsible for protocol",
"formal": "Indicates the authority who published the protocol? E.g. ACIP.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].participation[typeCode=AUT].COCT_MT090200UV"
}
]
}
},
{
"path": "Immunization.vaccinationProtocol.series",
"definition": {
"short": "Name of vaccine series",
"formal": "One possible path to achieve presumed immunity against a disease - within the context of an authority.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM]"
}
]
}
},
{
"path": "Immunization.vaccinationProtocol.seriesDoses",
"definition": {
"short": "Recommended number of doses for immunity",
"formal": "The recommended number of doses to achieve immunity.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].text"
}
]
}
},
{
"path": "Immunization.vaccinationProtocol.doseTarget",
"definition": {
"short": "Disease immunized against",
"formal": "The targeted disease.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "VaccinationProtocolDoseTarget",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/vaccination-protocol-dose-target"
}
},
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship.target[classCode=OBS].code"
}
]
}
},
{
"path": "Immunization.vaccinationProtocol.doseStatus",
"definition": {
"short": "Does dose count towards immunity?",
"formal": "Indicates if the immunization event should \"count\" against the protocol.",
"comments": "May need to differentiate between status declarations by a provider vs. a CDS engine.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "VaccinationProtocolDoseStatus",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/vaccination-protocol-dose-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].playedRole[classCode=INGR].scopedRole.scoper[classCode=MMAT].playedRole[classCode=HLTHCHRT].participation[typeCode=SBJ].observation[classCode=OBS].value"
}
]
}
},
{
"path": "Immunization.vaccinationProtocol.doseStatusReason",
"definition": {
"short": "Why does does count/not count?",
"formal": "Provides an explanation as to why a immunization event should or should not count against the protocol.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "VaccinationProtocolDoseStatusReason",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/vaccination-protocol-dose-status-reason"
}
},
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].playedRole[classCode=INGR].scopedRole.scoper[classCode=MMAT].playedRole[classCode=HLTHCHRT].participation[typeCode=SBJ].observation[classCode=OBS].reasonCode"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "date",
"type": "date",
"documentation": "Vaccination Administration / Refusal Date",
"xpath": "f:Immunization/f:date"
},
{
"name": "dose-sequence",
"type": "number",
"documentation": "What dose number within series?",
"xpath": "f:Immunization/f:vaccinationProtocol/f:doseSequence"
},
{
"name": "identifier",
"type": "token",
"documentation": "Business identifier",
"xpath": "f:Immunization/f:identifier"
},
{
"name": "location",
"type": "reference",
"documentation": "The service delivery location or facility in which the vaccine was / was to be administered",
"xpath": "f:Immunization/f:location"
},
{
"name": "lot-number",
"type": "string",
"documentation": "Vaccine Lot Number",
"xpath": "f:Immunization/f:lotNumber"
},
{
"name": "manufacturer",
"type": "reference",
"documentation": "Vaccine Manufacturer",
"xpath": "f:Immunization/f:manufacturer"
},
{
"name": "performer",
"type": "reference",
"documentation": "The practitioner who administered the vaccination",
"xpath": "f:Immunization/f:performer"
},
{
"name": "reaction",
"type": "reference",
"documentation": "Additional information on reaction",
"xpath": "f:Immunization/f:reaction/f:detail"
},
{
"name": "reaction-date",
"type": "date",
"documentation": "When did reaction start?",
"xpath": "f:Immunization/f:reaction/f:date"
},
{
"name": "reason",
"type": "token",
"documentation": "Why immunization occurred",
"xpath": "f:Immunization/f:explanation/f:reason"
},
{
"name": "refusal-reason",
"type": "token",
"documentation": "Explanation of refusal / exemption",
"xpath": "f:Immunization/f:explanation/f:refusalReason"
},
{
"name": "refused",
"type": "token",
"documentation": "Was immunization refused?",
"xpath": "f:Immunization/f:refusedIndicator"
},
{
"name": "requester",
"type": "reference",
"documentation": "The practitioner who ordered the vaccination",
"xpath": "f:Immunization/f:requester"
},
{
"name": "subject",
"type": "reference",
"documentation": "The subject of the vaccination event / refusal",
"xpath": "f:Immunization/f:subject"
},
{
"name": "vaccine-type",
"type": "token",
"documentation": "Vaccine Product Type Administered",
"xpath": "f:Immunization/f:vaccineType"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"Immunization event information.\" class=\"dict\" href=\"immunization-definitions.html#Immunization\"><b>Immunization</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"A unique identifier assigned to this adverse reaction record.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Business identifier</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Date vaccine administered or was to be administered.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.date\"><b>date</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Vaccination administration date</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Vaccine that was administered or was to be administered.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.vaccineType\"><b>vaccineType</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v3/vs/VaccineType/index.html\">Vaccine product administered</a><span style=\"color: Gray\"> --></span></vaccineType>\r\n <<a title=\"The patient to whom the vaccine was to be administered.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Who was immunized?</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"Indicates if the vaccination was refused.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.refusedIndicator\"><b>refusedIndicator</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Was immunization refused?</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"True if this administration was reported rather than directly administered.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.reported\"><b>reported</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Is this a self-reported record?</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Clinician who administered the vaccine.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.performer\"><b>performer</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">Who administered vaccine?</span><span style=\"color: Gray\"> --></span></performer>\r\n <<a title=\"Clinician who ordered the vaccination.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.requester\"><b>requester</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">Who ordered vaccination?</span><span style=\"color: Gray\"> --></span></requester>\r\n <<a title=\"Name of vaccine manufacturer.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.manufacturer\"><b>manufacturer</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">Vaccine manufacturer</span><span style=\"color: Gray\"> --></span></manufacturer>\r\n <<a title=\"The service delivery location where the vaccine administration occurred.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.location\"><b>location</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">Where did vaccination occur?</span><span style=\"color: Gray\"> --></span></location>\r\n <<a title=\"Lot number of the vaccine product.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.lotNumber\"><b>lotNumber</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Vaccine lot number</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Date vaccine batch expires.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.expirationDate\"><b>expirationDate</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#date\">date</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Vaccine expiration date</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Body site where vaccine was administered.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.site\"><b>site</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-immunization-site.html\">Body site vaccine was administered</a></span><span style=\"color: Gray\"> --></span></site>\r\n <<a title=\"The path by which the vaccine product is taken into the body.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.route\"><b>route</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-immunization-route.html\">How vaccine entered body</a></span><span style=\"color: Gray\"> --></span></route>\r\n <<a title=\"The quantity of vaccine product that was administered.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.doseQuantity\"><b>doseQuantity</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">Amount of vaccine administered</span><span style=\"color: Gray\"> --></span></doseQuantity>\r\n <<a title=\"Reasons why a vaccine was administered or refused.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.explanation\"><b>explanation</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> Administration / refusal reasons --></span>\r\n <<a title=\"Reasons why a vaccine was administered.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.explanation.reason\"><b>reason</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-immunization-reason.html\">Why immunization occurred</a></span><span style=\"color: Gray\"> --></span></reason>\r\n <<a title=\"Refusal or exemption reasons.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.explanation.refusalReason\"><b>refusalReason</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-no-immunization-reason.html\">Why immunization did not occur</a></span><span style=\"color: Gray\"> --></span></refusalReason>\r\n </explanation>\r\n <<a title=\"Categorical data indicating that an adverse event is associated in time to an immunization.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.reaction\"><b>reaction</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Details of a reaction that follows immunization --></span>\r\n <<a title=\"Date of reaction to the immunization.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.reaction.date\"><b>date</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When did reaction start?</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Details of the reaction.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.reaction.detail\"><b>detail</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"adversereaction.html#AdverseReaction\">AdverseReaction</a>|<a href=\"observation.html#Observation\">Observation</a>)</span> <span style=\"color: navy\">Additional information on reaction</span><span style=\"color: Gray\"> --></span></detail>\r\n <<a title=\"Self-reported indicator.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.reaction.reported\"><b>reported</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Was reaction self-reported?</span><span style=\"color: Gray\"> --></span>\r\n </reaction>\r\n <<a title=\"Contains information about the protocol(s) under which the vaccine was administered.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.vaccinationProtocol\"><b>vaccinationProtocol</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> What protocol was followed --></span>\r\n <<a title=\"Nominal position in a series.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.vaccinationProtocol.doseSequence\"><b>doseSequence</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">What dose number within series?</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Contains the description about the protocol under which the vaccine was administered.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.vaccinationProtocol.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Details of vaccine protocol</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Indicates the authority who published the protocol? E.g. ACIP.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.vaccinationProtocol.authority\"><b>authority</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">Who is responsible for protocol</span><span style=\"color: Gray\"> --></span></authority>\r\n <<a title=\"One possible path to achieve presumed immunity against a disease - within the context of an authority.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.vaccinationProtocol.series\"><b>series</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Name of vaccine series</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The recommended number of doses to achieve immunity.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.vaccinationProtocol.seriesDoses\"><b>seriesDoses</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Recommended number of doses for immunity</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The targeted disease.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.vaccinationProtocol.doseTarget\"><b>doseTarget</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-vaccination-protocol-dose-target.html\">Disease immunized against</a></span><span style=\"color: Gray\"> --></span></doseTarget>\r\n <<a title=\"Indicates if the immunization event should "count" against the protocol.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.vaccinationProtocol.doseStatus\"><b>doseStatus</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-vaccination-protocol-dose-status.html\">Does dose count towards immunity?</a></span><span style=\"color: Gray\"> --></span></doseStatus>\r\n <<a title=\"Provides an explanation as to why a immunization event should or should not count against the protocol.\" class=\"dict\" href=\"immunization-definitions.html#Immunization.vaccinationProtocol.doseStatusReason\"><b>doseStatusReason</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-vaccination-protocol-dose-status-reason.html\">Why does does count/not count?</a></span><span style=\"color: Gray\"> --></span></doseStatusReason>\r\n </vaccinationProtocol>\r\n</Immunization>\r\n</pre></div>"
},
{
"title": "\"immunizationrecommendation\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/immunizationrecommendation",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/immunizationrecommendation.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"A patient's point-of-time immunization status and recommendation with optional supporting justification.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation\"><b>ImmunizationRecommendation</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"A unique identifier assigned to this particular recommendation record.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Business identifier</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"The patient who is the subject of the profile.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Who this profile is for</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"Vaccine administration recommendations.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation\"><b>recommendation</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..*</b></span> Vaccine administration recommendations --></span>\r\n <<a title=\"The date the immunization recommendation was created.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.date\"><b>date</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Date recommendation created</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Vaccine that pertains to the recommendation.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.vaccineType\"><b>vaccineType</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v3/vs/VaccineType/index.html\">Vaccine recommendation applies to</a><span style=\"color: Gray\"> --></span></vaccineType>\r\n <<a title=\"This indicates the next recommended dose number (e.g. dose 2 is the next recommended dose).\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.doseNumber\"><b>doseNumber</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Recommended dose number</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Vaccine administration status.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.forecastStatus\"><b>forecastStatus</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-immunization-recommendation-status.html\">Vaccine administration status</a></span><span style=\"color: Gray\"> --></span></forecastStatus>\r\n <<a title=\"Vaccine date recommendations - e.g. earliest date to administer, latest date to administer, etc.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.dateCriterion\"><b>dateCriterion</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Dates governing proposed immunization --></span>\r\n <<a title=\"Date classification of recommendation - e.g. earliest date to give, latest date to give, etc.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.dateCriterion.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-immunization-recommendation-date-criterion.html\">Type of date</a></span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"Date recommendation.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.dateCriterion.value\"><b>value</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Recommended date</span><span style=\"color: Gray\"> --></span>\r\n </dateCriterion>\r\n <<a title=\"Contains information about the protocol under which the vaccine was administered.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.protocol\"><b>protocol</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> Protocol used by recommendation --></span>\r\n <<a title=\"Indicates the nominal position in a series of the next dose. This is the recommended dose number as per a specified protocol.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.protocol.doseSequence\"><b>doseSequence</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Number of dose within sequence</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Contains the description about the protocol under which the vaccine was administered.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.protocol.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Protocol details</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Indicates the authority who published the protocol? E.g. ACIP.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.protocol.authority\"><b>authority</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">Who is responsible for protocol</span><span style=\"color: Gray\"> --></span></authority>\r\n <<a title=\"One possible path to achieve presumed immunity against a disease - within the context of an authority.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.protocol.series\"><b>series</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Name of vaccination series</span><span style=\"color: Gray\"> --></span>\r\n </protocol>\r\n <<a title=\"Immunization event history that supports the status and recommendation.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.supportingImmunization\"><b>supportingImmunization</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"immunization.html#Immunization\">Immunization</a>)</span> <span style=\"color: navy\">\r\n Past immunizations supporting recommendation</span><span style=\"color: Gray\"> --></span></supportingImmunization>\r\n <<a title=\"Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.supportingPatientInformation\"><b>supportingPatientInformation</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"observation.html#Observation\">Observation</a>|<a href=\"adversereaction.html#AdverseReaction\">AdverseReaction</a>|\r\n <a href=\"allergyintolerance.html#AllergyIntolerance\">AllergyIntolerance</a>)</span> <span style=\"color: navy\">Patient observations supporting recommendation</span><span style=\"color: Gray\"> --></span></supportingPatientInformation>\r\n </recommendation>\r\n</ImmunizationRecommendation>\r\n</pre></div>"
},
"name": "immunizationrecommendation",
"publisher": "FHIR Project",
"description": "Basic Profile. A patient's point-of-time immunization status and recommendation with optional supporting justification.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage The ImmunizationRecommendation resource is intended to cover communication of a specified patient's immunization recommendation and status across all healthcare disciplines in all care settings and all regions. \r\n\r\nAdditionally, the ImmunizationRecommendation resource is expected to cover key concepts related to the querying of a patient's immunization recommendation and status. This resource - through consultation with the PHER work group - is believed to meet key use cases and information requirements as defined in the existing HL7 v3 POIZ domain and Immunization Domain Analysis Model.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "ImmunizationRecommendation",
"publish": true,
"element": [
{
"path": "ImmunizationRecommendation",
"definition": {
"short": "Immunization profile",
"formal": "A patient's point-of-time immunization status and recommendation with optional supporting justification.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "SubstanceAdministration[moodCode=RMD]"
},
{
"identity": "v2",
"map": "VXU_V04"
}
]
}
},
{
"path": "ImmunizationRecommendation.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ImmunizationRecommendation.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ImmunizationRecommendation.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "ImmunizationRecommendation.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "ImmunizationRecommendation.identifier",
"definition": {
"short": "Business identifier",
"formal": "A unique identifier assigned to this particular recommendation record.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
}
},
{
"path": "ImmunizationRecommendation.subject",
"definition": {
"short": "Who this profile is for",
"formal": "The patient who is the subject of the profile.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".partipication[typeCode=SUBJ].role"
},
{
"identity": "v2",
"map": "PID-3-patient ID list"
}
]
}
},
{
"path": "ImmunizationRecommendation.recommendation",
"definition": {
"short": "Vaccine administration recommendations",
"formal": "Vaccine administration recommendations.",
"min": 1,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode='COMP'].target[classCode=SBADM, moodCode=RMD]"
}
]
}
},
{
"path": "ImmunizationRecommendation.recommendation.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ImmunizationRecommendation.recommendation.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ImmunizationRecommendation.recommendation.date",
"definition": {
"short": "Date recommendation created",
"formal": "The date the immunization recommendation was created.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".partipication[typeCode=AUTH].time"
},
{
"identity": "v2",
"map": "OBX-15-date/time of the observation"
}
]
}
},
{
"path": "ImmunizationRecommendation.recommendation.vaccineType",
"definition": {
"short": "Vaccine recommendation applies to",
"formal": "Vaccine that pertains to the recommendation.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "VaccineType",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/v3/vs/VaccineType"
}
},
"mapping": [
{
"identity": "rim",
"map": ".partipication[typeCode=CSM].role[classCode=ADMM].code"
},
{
"identity": "v2",
"map": "OBX-5-observation value : OBX-3-observation identifier e { 30956-7 | 38890-0 }"
}
]
}
},
{
"path": "ImmunizationRecommendation.recommendation.doseNumber",
"definition": {
"short": "Recommended dose number",
"formal": "This indicates the next recommended dose number (e.g. dose 2 is the next recommended dose).",
"comments": "May need other dose concepts such as administered vs. valid.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP, .source[classCode=SBADM, moodCode=INT]].sequenceNumber"
},
{
"identity": "v2",
"map": "OBX-5-observation value : OBX-3-observation identifier = 30973-2"
}
]
}
},
{
"path": "ImmunizationRecommendation.recommendation.forecastStatus",
"definition": {
"short": "Vaccine administration status",
"formal": "Vaccine administration status.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ImmunizationRecommendationStatus",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/immunization-recommendation-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ] .source[classCode=OBS, moodCode=EVN, code=\"Immunization Forecast Status\"].value"
},
{
"identity": "v2",
"map": "OBX-5-observation value : OBX-3-observation identifier = 59783-1"
}
]
}
},
{
"path": "ImmunizationRecommendation.recommendation.dateCriterion",
"definition": {
"short": "Dates governing proposed immunization",
"formal": "Vaccine date recommendations - e.g. earliest date to administer, latest date to administer, etc.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode='LIMIT'].target[classCode=OBS, moodCode=EVN, isCriterionInd=true]"
},
{
"identity": "v2",
"map": "OBX-3: 30980-7 = Next dose recommended, 59777-3 = Latest next dose should be given, 59778-1 = Dose is overdue"
}
]
}
},
{
"path": "ImmunizationRecommendation.recommendation.dateCriterion.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ImmunizationRecommendation.recommendation.dateCriterion.code",
"definition": {
"short": "Type of date",
"formal": "Date classification of recommendation - e.g. earliest date to give, latest date to give, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ImmunizationRecommendationDateCriterion",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/immunization-recommendation-date-criterion"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "v2",
"map": "OBX-3-observation identifier"
}
]
}
},
{
"path": "ImmunizationRecommendation.recommendation.dateCriterion.value",
"definition": {
"short": "Recommended date",
"formal": "Date recommendation.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".value"
},
{
"identity": "v2",
"map": "OBX-5-observation value"
}
]
}
},
{
"path": "ImmunizationRecommendation.recommendation.protocol",
"definition": {
"short": "Protocol used by recommendation",
"formal": "Contains information about the protocol under which the vaccine was administered.",
"min": 0,
"max": "1",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=INST].source[classCode=SBADM, moodCode=DEF]"
}
]
}
},
{
"path": "ImmunizationRecommendation.recommendation.protocol.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ImmunizationRecommendation.recommendation.protocol.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ImmunizationRecommendation.recommendation.protocol.doseSequence",
"definition": {
"short": "Number of dose within sequence",
"formal": "Indicates the nominal position in a series of the next dose. This is the recommended dose number as per a specified protocol.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP, .source[classCode=SBADM, moodCode=DEF]].sequenceNumber"
},
{
"identity": "v2",
"map": "OBX-5-observation value : OBX-3-observation identifier = 30973-2"
}
]
}
},
{
"path": "ImmunizationRecommendation.recommendation.protocol.description",
"definition": {
"short": "Protocol details",
"formal": "Contains the description about the protocol under which the vaccine was administered.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".text"
},
{
"identity": "v2",
"map": "OBX-5-observation value : OBX-3-observation identifier = 30956-7"
}
]
}
},
{
"path": "ImmunizationRecommendation.recommendation.protocol.authority",
"definition": {
"short": "Who is responsible for protocol",
"formal": "Indicates the authority who published the protocol? E.g. ACIP.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT]"
},
{
"identity": "v2",
"map": "OBX-5-observation value : OBX-3-observation identifier = 59779-9"
}
]
}
},
{
"path": "ImmunizationRecommendation.recommendation.protocol.series",
"definition": {
"short": "Name of vaccination series",
"formal": "One possible path to achieve presumed immunity against a disease - within the context of an authority.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".title"
},
{
"identity": "v2",
"map": "RXA-5-administered code"
}
]
}
},
{
"path": "ImmunizationRecommendation.recommendation.supportingImmunization",
"definition": {
"short": "Past immunizations supporting recommendation",
"formal": "Immunization event history that supports the status and recommendation.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Immunization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RSON].target[classCode=SBADM, moodCode=EVN, code=\"immunization\"]"
},
{
"identity": "v2",
"map": "? No clear way to associate in V2.x or IG"
}
]
}
},
{
"path": "ImmunizationRecommendation.recommendation.supportingPatientInformation",
"definition": {
"short": "Patient observations supporting recommendation",
"formal": "Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Observation"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/AdverseReaction"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/AllergyIntolerance"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RSON].target[classCode=OBS, moodCode=EVN]"
},
{
"identity": "v2",
"map": "OBX If OBX is associated with ( RXA : RXA-5-administered code = '998^No vaccine administered^CVX' ), could contain the reason the vaccine was not administered"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "date",
"type": "date",
"documentation": "Date recommendation created",
"xpath": "f:ImmunizationRecommendation/f:recommendation/f:date"
},
{
"name": "dose-number",
"type": "number",
"documentation": "Recommended dose number",
"xpath": "f:ImmunizationRecommendation/f:recommendation/f:doseNumber"
},
{
"name": "dose-sequence",
"type": "token",
"documentation": "Number of dose within sequence",
"xpath": "f:ImmunizationRecommendation/f:recommendation/f:protocol/f:doseSequence"
},
{
"name": "identifier",
"type": "token",
"documentation": "Business identifier",
"xpath": "f:ImmunizationRecommendation/f:identifier"
},
{
"name": "information",
"type": "reference",
"documentation": "Patient observations supporting recommendation",
"xpath": "f:ImmunizationRecommendation/f:recommendation/f:supportingPatientInformation"
},
{
"name": "status",
"type": "token",
"documentation": "Vaccine administration status",
"xpath": "f:ImmunizationRecommendation/f:recommendation/f:forecastStatus"
},
{
"name": "subject",
"type": "reference",
"documentation": "Who this profile is for",
"xpath": "f:ImmunizationRecommendation/f:subject"
},
{
"name": "support",
"type": "reference",
"documentation": "Past immunizations supporting recommendation",
"xpath": "f:ImmunizationRecommendation/f:recommendation/f:supportingImmunization"
},
{
"name": "vaccine-type",
"type": "token",
"documentation": "Vaccine recommendation applies to",
"xpath": "f:ImmunizationRecommendation/f:recommendation/f:vaccineType"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"A patient's point-of-time immunization status and recommendation with optional supporting justification.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation\"><b>ImmunizationRecommendation</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"A unique identifier assigned to this particular recommendation record.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Business identifier</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"The patient who is the subject of the profile.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Who this profile is for</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"Vaccine administration recommendations.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation\"><b>recommendation</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..*</b></span> Vaccine administration recommendations --></span>\r\n <<a title=\"The date the immunization recommendation was created.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.date\"><b>date</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Date recommendation created</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Vaccine that pertains to the recommendation.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.vaccineType\"><b>vaccineType</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v3/vs/VaccineType/index.html\">Vaccine recommendation applies to</a><span style=\"color: Gray\"> --></span></vaccineType>\r\n <<a title=\"This indicates the next recommended dose number (e.g. dose 2 is the next recommended dose).\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.doseNumber\"><b>doseNumber</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Recommended dose number</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Vaccine administration status.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.forecastStatus\"><b>forecastStatus</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-immunization-recommendation-status.html\">Vaccine administration status</a></span><span style=\"color: Gray\"> --></span></forecastStatus>\r\n <<a title=\"Vaccine date recommendations - e.g. earliest date to administer, latest date to administer, etc.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.dateCriterion\"><b>dateCriterion</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Dates governing proposed immunization --></span>\r\n <<a title=\"Date classification of recommendation - e.g. earliest date to give, latest date to give, etc.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.dateCriterion.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-immunization-recommendation-date-criterion.html\">Type of date</a></span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"Date recommendation.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.dateCriterion.value\"><b>value</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Recommended date</span><span style=\"color: Gray\"> --></span>\r\n </dateCriterion>\r\n <<a title=\"Contains information about the protocol under which the vaccine was administered.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.protocol\"><b>protocol</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> Protocol used by recommendation --></span>\r\n <<a title=\"Indicates the nominal position in a series of the next dose. This is the recommended dose number as per a specified protocol.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.protocol.doseSequence\"><b>doseSequence</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Number of dose within sequence</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Contains the description about the protocol under which the vaccine was administered.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.protocol.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Protocol details</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Indicates the authority who published the protocol? E.g. ACIP.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.protocol.authority\"><b>authority</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">Who is responsible for protocol</span><span style=\"color: Gray\"> --></span></authority>\r\n <<a title=\"One possible path to achieve presumed immunity against a disease - within the context of an authority.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.protocol.series\"><b>series</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Name of vaccination series</span><span style=\"color: Gray\"> --></span>\r\n </protocol>\r\n <<a title=\"Immunization event history that supports the status and recommendation.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.supportingImmunization\"><b>supportingImmunization</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"immunization.html#Immunization\">Immunization</a>)</span> <span style=\"color: navy\">\r\n Past immunizations supporting recommendation</span><span style=\"color: Gray\"> --></span></supportingImmunization>\r\n <<a title=\"Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.\" class=\"dict\" href=\"immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.supportingPatientInformation\"><b>supportingPatientInformation</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"observation.html#Observation\">Observation</a>|<a href=\"adversereaction.html#AdverseReaction\">AdverseReaction</a>|\r\n <a href=\"allergyintolerance.html#AllergyIntolerance\">AllergyIntolerance</a>)</span> <span style=\"color: navy\">Patient observations supporting recommendation</span><span style=\"color: Gray\"> --></span></supportingPatientInformation>\r\n </recommendation>\r\n</ImmunizationRecommendation>\r\n</pre></div>"
},
{
"title": "\"list\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/list",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/list.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"A set of information summarized from a list of other resources.\" class=\"dict\" href=\"list-definitions.html#List\"><b>List</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Identifier for the List assigned for business purposes outside the context of FHIR.\" class=\"dict\" href=\"list-definitions.html#List.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Business identifier</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"This code defines the purpose of the list - why it was created.\" class=\"dict\" href=\"list-definitions.html#List.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-list-example-codes.html\">What the purpose of this list is</a></span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"The common subject (or patient) of the resources that are in the list, if there is one.\" class=\"dict\" href=\"list-definitions.html#List.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"group.html#Group\">Group</a>|<a href=\"device.html#Device\">Device</a>|<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">\r\n If all resources have the same subject</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"The entity responsible for deciding what the contents of the list were.\" class=\"dict\" href=\"list-definitions.html#List.source\"><b>source</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"patient.html#Patient\">Patient</a>|<a href=\"device.html#Device\">Device</a>)</span> <span style=\"color: navy\">\r\n Who and/or what defined the list contents</span><span style=\"color: Gray\"> --></span></source>\r\n <<a title=\"The date that the list was prepared.\" class=\"dict\" href=\"list-definitions.html#List.date\"><b>date</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When the list was prepared</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Whether items in the list have a meaningful order (this element modifies the meaning of other elements)\" class=\"dict\" href=\"list-definitions.html#List.ordered\"><span style=\"text-decoration: underline\"><b>ordered</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Whether items in the list have a meaningful order</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted (this element modifies the meaning of other elements)\" class=\"dict\" href=\"list-definitions.html#List.mode\"><span style=\"text-decoration: underline\"><b>mode</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"list-mode.html\">working | snapshot | changes</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Entries in this list.\" class=\"dict\" href=\"list-definitions.html#List.entry\"><b>entry</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-1: A list can only have an emptyReason if it is empty\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> Entries in the list --></span>\r\n <<a title=\"The flag allows the system constructing the list to make one or more statements about the role and significance of the item in the list.\" class=\"dict\" href=\"list-definitions.html#List.entry.flag\"><b>flag</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-list-item-flag.html\">Workflow information about this item</a></span><span style=\"color: Gray\"> --></span></flag>\r\n <<a title=\"True if this item is marked as deleted in the list (this element modifies the meaning of other elements)\" class=\"dict\" href=\"list-definitions.html#List.entry.deleted\"><span style=\"text-decoration: underline\"><b>deleted</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: The deleted flag can only be used if the mode of the list is "changes"\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">If this item is actually marked as deleted</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"When this item was added to the list.\" class=\"dict\" href=\"list-definitions.html#List.entry.date\"><b>date</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When item added to list</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A reference to the actual resource from which data was derived.\" class=\"dict\" href=\"list-definitions.html#List.entry.item\"><b>item</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">Actual entry</span><span style=\"color: Gray\"> --></span></item>\r\n </entry>\r\n <<a title=\"If the list is empty, why the list is empty.\" class=\"dict\" href=\"list-definitions.html#List.emptyReason\"><b>emptyReason</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: A list can only have an emptyReason if it is empty\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-list-empty-reason.html\">Why list is empty</a></span><span style=\"color: Gray\"> --></span></emptyReason>\r\n</List>\r\n</pre></div>"
},
"name": "list",
"publisher": "FHIR Project",
"description": "Basic Profile. A set of information summarized from a list of other resources.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage List resources are used in many places, including allergies, medications, alerts, medical history, etc.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"structure": [
{
"type": "List",
"publish": true,
"element": [
{
"path": "List",
"definition": {
"short": "Information summarized from a list of other resources",
"formal": "A set of information summarized from a list of other resources.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"constraint": [
{
"key": "2",
"name": "Deleted Rule",
"severity": "error",
"human": "The deleted flag can only be used if the mode of the list is \"changes\"",
"xpath": "(f:mode/@value = 'changes') or not(exists(f:entry/f:item/f:deleted))"
},
{
"key": "1",
"name": "No emptyReason if list is not empty",
"severity": "error",
"human": "A list can only have an emptyReason if it is empty",
"xpath": "not(exists(f:emptyReason) and exists(f:entry))"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Act[classCode<ORG,moodCode=EVN]"
}
]
}
},
{
"path": "List.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "List.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "List.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "List.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "List.identifier",
"definition": {
"short": "Business identifier",
"formal": "Identifier for the List assigned for business purposes outside the context of FHIR.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
}
},
{
"path": "List.code",
"definition": {
"short": "What the purpose of this list is",
"formal": "This code defines the purpose of the list - why it was created.",
"comments": "If there is no code, the purpose of the list is implied where it is used, such as in a document section using Document.section.code.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ListPurpose",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/list-example-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
}
},
{
"path": "List.subject",
"definition": {
"short": "If all resources have the same subject",
"formal": "The common subject (or patient) of the resources that are in the list, if there is one.",
"comments": "Some purely aribitrary lists do not have a common subject, so this is optional.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Group"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Location"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode<SUB].role\n(and sometimes .player)"
}
]
}
},
{
"path": "List.source",
"definition": {
"short": "Who and/or what defined the list contents",
"formal": "The entity responsible for deciding what the contents of the list were.",
"comments": "The primary source is the entity that made the decisions what items are in the list. This may be software or user.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode<AUT].role[classCode=REL].player[classCode=PSN,determinerCode=INST]\nor\n.participation[typeCode<AUT].role[classCode=REL].player[classCode=DEV,determinerCode=INST]"
}
]
}
},
{
"path": "List.date",
"definition": {
"short": "When the list was prepared",
"formal": "The date that the list was prepared.",
"comments": "The actual important date is the date of currency of the resources that were summarized, but it is usually assumed that these are current when the preparation occurs.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode<AUT].time[type=TS]"
}
]
}
},
{
"path": "List.ordered",
"definition": {
"short": "Whether items in the list have a meaningful order",
"formal": "Whether items in the list have a meaningful order.",
"comments": "Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. This is marked as \"is modifier\" because whether the list is ordered or not may change how the results are processed or displayed.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].sequenceNumber > 1"
}
]
}
},
{
"path": "List.mode",
"definition": {
"short": "working | snapshot | changes",
"formal": "How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "ListMode",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/list-mode"
}
},
"mapping": [
{
"identity": "rim",
"map": ".outBoundRelationship[typeCode=COMP].target[classCode=OBS\"].value"
}
]
}
},
{
"path": "List.entry",
"definition": {
"short": "Entries in the list",
"formal": "Entries in this list.",
"comments": "If there are no entries in the list, an emptyReason SHOULD be provided.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP]\nor \n.participation[typeCode=SBJ]"
}
]
}
},
{
"path": "List.entry.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "List.entry.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "List.entry.flag",
"definition": {
"short": "Workflow information about this item",
"formal": "The flag allows the system constructing the list to make one or more statements about the role and significance of the item in the list.",
"comments": "The flag can only be understood in the context of the List.code. If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true. Deleted can only be used if the List.mode is \"changes\".",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ListItemFlag",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/list-item-flag"
}
},
"mapping": [
{
"identity": "rim",
"map": ".outBoundRelationship[typeCode=COMP].target[classCode=OBS\"].value"
}
]
}
},
{
"path": "List.entry.deleted",
"definition": {
"short": "If this item is actually marked as deleted",
"formal": "True if this item is marked as deleted in the list.",
"comments": "If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true. Both flag and deleted can only be used if the List.mode is \"changes\". A deleted entry should be displayed in narrative as deleted.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "added: .updateMode=(\"A\",\"AR\")\n\nretained: .updateMode=\"NC\"\n\nupdated: .updateMode=\"R\"\n\ndeleted: .updateMode=\"D\""
}
]
}
},
{
"path": "List.entry.date",
"definition": {
"short": "When item added to list",
"formal": "When this item was added to the list.",
"comments": "This is only useful and meaningful when the mode is \"working\".",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".availabilityTime"
}
]
}
},
{
"path": "List.entry.item",
"definition": {
"short": "Actual entry",
"formal": "A reference to the actual resource from which data was derived.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Any"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".target\nor\n.role\nor\n.role.entity"
}
]
}
},
{
"path": "List.emptyReason",
"definition": {
"short": "Why list is empty",
"formal": "If the list is empty, why the list is empty.",
"comments": "The various reasons for an empty list make a significant interpretation to its interpretation.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ListEmptyReason",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/list-empty-reason"
}
},
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ,code<{ListEmptyReason}].value[type=CD]"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "code",
"type": "token",
"documentation": "What the purpose of this list is",
"xpath": "f:List/f:code"
},
{
"name": "date",
"type": "date",
"documentation": "When the list was prepared",
"xpath": "f:List/f:date"
},
{
"name": "empty-reason",
"type": "token",
"documentation": "Why list is empty",
"xpath": "f:List/f:emptyReason"
},
{
"name": "item",
"type": "reference",
"documentation": "Actual entry",
"xpath": "f:List/f:entry/f:item"
},
{
"name": "source",
"type": "reference",
"documentation": "Who and/or what defined the list contents",
"xpath": "f:List/f:source"
},
{
"name": "subject",
"type": "reference",
"documentation": "If all resources have the same subject",
"xpath": "f:List/f:subject"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"A set of information summarized from a list of other resources.\" class=\"dict\" href=\"list-definitions.html#List\"><b>List</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Identifier for the List assigned for business purposes outside the context of FHIR.\" class=\"dict\" href=\"list-definitions.html#List.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Business identifier</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"This code defines the purpose of the list - why it was created.\" class=\"dict\" href=\"list-definitions.html#List.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-list-example-codes.html\">What the purpose of this list is</a></span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"The common subject (or patient) of the resources that are in the list, if there is one.\" class=\"dict\" href=\"list-definitions.html#List.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"group.html#Group\">Group</a>|<a href=\"device.html#Device\">Device</a>|<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">\r\n If all resources have the same subject</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"The entity responsible for deciding what the contents of the list were.\" class=\"dict\" href=\"list-definitions.html#List.source\"><b>source</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"patient.html#Patient\">Patient</a>|<a href=\"device.html#Device\">Device</a>)</span> <span style=\"color: navy\">\r\n Who and/or what defined the list contents</span><span style=\"color: Gray\"> --></span></source>\r\n <<a title=\"The date that the list was prepared.\" class=\"dict\" href=\"list-definitions.html#List.date\"><b>date</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When the list was prepared</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Whether items in the list have a meaningful order (this element modifies the meaning of other elements)\" class=\"dict\" href=\"list-definitions.html#List.ordered\"><span style=\"text-decoration: underline\"><b>ordered</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Whether items in the list have a meaningful order</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted (this element modifies the meaning of other elements)\" class=\"dict\" href=\"list-definitions.html#List.mode\"><span style=\"text-decoration: underline\"><b>mode</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"list-mode.html\">working | snapshot | changes</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Entries in this list.\" class=\"dict\" href=\"list-definitions.html#List.entry\"><b>entry</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-1: A list can only have an emptyReason if it is empty\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> Entries in the list --></span>\r\n <<a title=\"The flag allows the system constructing the list to make one or more statements about the role and significance of the item in the list.\" class=\"dict\" href=\"list-definitions.html#List.entry.flag\"><b>flag</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-list-item-flag.html\">Workflow information about this item</a></span><span style=\"color: Gray\"> --></span></flag>\r\n <<a title=\"True if this item is marked as deleted in the list (this element modifies the meaning of other elements)\" class=\"dict\" href=\"list-definitions.html#List.entry.deleted\"><span style=\"text-decoration: underline\"><b>deleted</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: The deleted flag can only be used if the mode of the list is "changes"\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">If this item is actually marked as deleted</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"When this item was added to the list.\" class=\"dict\" href=\"list-definitions.html#List.entry.date\"><b>date</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When item added to list</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A reference to the actual resource from which data was derived.\" class=\"dict\" href=\"list-definitions.html#List.entry.item\"><b>item</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">Actual entry</span><span style=\"color: Gray\"> --></span></item>\r\n </entry>\r\n <<a title=\"If the list is empty, why the list is empty.\" class=\"dict\" href=\"list-definitions.html#List.emptyReason\"><b>emptyReason</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: A list can only have an emptyReason if it is empty\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-list-empty-reason.html\">Why list is empty</a></span><span style=\"color: Gray\"> --></span></emptyReason>\r\n</List>\r\n</pre></div>"
},
{
"title": "\"location\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/location",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/location.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated.\" class=\"dict\" href=\"location-definitions.html#Location\"><b>Location</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Unique code or number identifying the location to its users.\" class=\"dict\" href=\"location-definitions.html#Location.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">\r\n Unique code or number identifying the location to its users</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Name of the location as used by humans. Does not need to be unique.\" class=\"dict\" href=\"location-definitions.html#Location.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Name of the location as used by humans</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Description of the Location, which helps in finding or referencing the place.\" class=\"dict\" href=\"location-definitions.html#Location.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Description of the Location, which helps in finding or referencing the place</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Indicates the type of function performed at the location.\" class=\"dict\" href=\"location-definitions.html#Location.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v3/vs/ServiceDeliveryLocationRoleType/index.html\">Indicates the type of function performed at the location</a><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.\" class=\"dict\" href=\"location-definitions.html#Location.telecom\"><b>telecom</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">Contact details of the location</span><span style=\"color: Gray\"> --></span></telecom>\r\n <<a title=\"Physical location.\" class=\"dict\" href=\"location-definitions.html#Location.address\"><b>address</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Address\">Address</a></span> <span style=\"color: navy\">Physical location</span><span style=\"color: Gray\"> --></span></address>\r\n <<a title=\"Physical form of the location, e.g. building, room, vehicle, road.\" class=\"dict\" href=\"location-definitions.html#Location.physicalType\"><b>physicalType</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-location-physical-type.html\">Physical form of the location</a></span><span style=\"color: Gray\"> --></span></physicalType>\r\n <<a title=\"The absolute geographic location of the Location, expressed in a KML compatible manner (see notes below for KML).\" class=\"dict\" href=\"location-definitions.html#Location.position\"><b>position</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> The absolute geographic location --></span>\r\n <<a title=\"Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).\" class=\"dict\" href=\"location-definitions.html#Location.position.longitude\"><b>longitude</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#decimal\">decimal</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Longitude as expressed in KML</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).\" class=\"dict\" href=\"location-definitions.html#Location.position.latitude\"><b>latitude</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#decimal\">decimal</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Latitude as expressed in KML</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).\" class=\"dict\" href=\"location-definitions.html#Location.position.altitude\"><b>altitude</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#decimal\">decimal</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Altitude as expressed in KML</span><span style=\"color: Gray\"> --></span>\r\n </position>\r\n <<a title=\"The organization that is responsible for the provisioning and upkeep of the location.\" class=\"dict\" href=\"location-definitions.html#Location.managingOrganization\"><b>managingOrganization</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">\r\n The organization that is responsible for the provisioning and upkeep of the location</span><span style=\"color: Gray\"> --></span></managingOrganization>\r\n <<a title=\"active | suspended | inactive (this element modifies the meaning of other elements)\" class=\"dict\" href=\"location-definitions.html#Location.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"location-status.html\">active | suspended | inactive</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Another Location which this Location is physically part of.\" class=\"dict\" href=\"location-definitions.html#Location.partOf\"><b>partOf</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">\r\n Another Location which this Location is physically part of</span><span style=\"color: Gray\"> --></span></partOf>\r\n <<a title=\"Indicates whether a resource instance represents a specific location or a class of locations (this element modifies the meaning of other elements)\" class=\"dict\" href=\"location-definitions.html#Location.mode\"><span style=\"text-decoration: underline\"><b>mode</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"location-mode.html\">instance | kind</a></span><span style=\"color: Gray\"> --></span>\r\n</Location>\r\n</pre></div>"
},
"name": "location",
"publisher": "FHIR Project",
"description": "Basic Profile. Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage A Location includes both incidental locations (a place which is used for healthcare without prior designation or authorization) and dedicated, formally appointed locations. Locations may be private, public, mobile or fixed and scale from small freezers to full hospital buildings or parking garages. \r\n\r\nExamples of Locations are:\r\n\r\n* Building, ward, corridor or room\r\n* Freezer, incubator\r\n* Vehicle or lift\r\n* Home, shed, or a garage\r\n* Road, parking place, a park",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"structure": [
{
"type": "Location",
"publish": true,
"element": [
{
"path": "Location",
"definition": {
"short": "Details and position information for a physical place",
"formal": "Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Role[classCode=SDLC]."
}
]
}
},
{
"path": "Location.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Location.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Location.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "Location.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "Location.identifier",
"definition": {
"short": "Unique code or number identifying the location to its users",
"formal": "Unique code or number identifying the location to its users.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "id"
}
]
}
},
{
"path": "Location.name",
"definition": {
"short": "Name of the location as used by humans",
"formal": "Name of the location as used by humans. Does not need to be unique.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "name"
}
]
}
},
{
"path": "Location.description",
"definition": {
"short": "Description of the Location, which helps in finding or referencing the place",
"formal": "Description of the Location, which helps in finding or referencing the place.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "playingEntity[classCode=PLC determinerCode=INSTANCE].desc"
}
]
}
},
{
"path": "Location.type",
"definition": {
"short": "Indicates the type of function performed at the location",
"formal": "Indicates the type of function performed at the location.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "LocationType",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/v3/vs/ServiceDeliveryLocationRoleType"
}
},
"mapping": [
{
"identity": "rim",
"map": "code"
}
]
}
},
{
"path": "Location.telecom",
"definition": {
"short": "Contact details of the location",
"formal": "The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.",
"min": 0,
"max": "*",
"type": [
{
"code": "Contact"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "telecom"
}
]
}
},
{
"path": "Location.address",
"definition": {
"short": "Physical location",
"formal": "Physical location.",
"comments": "This was kept as 0..1 as there is no use property on the address, so wouldn't be able to identify different address types.",
"min": 0,
"max": "1",
"type": [
{
"code": "Address"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "addr"
}
]
}
},
{
"path": "Location.physicalType",
"definition": {
"short": "Physical form of the location",
"formal": "Physical form of the location, e.g. building, room, vehicle, road.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "PhysicalType",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/location-physical-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "playingEntity [classCode=PLC].code"
}
]
}
},
{
"path": "Location.position",
"definition": {
"short": "The absolute geographic location",
"formal": "The absolute geographic location of the Location, expressed in a KML compatible manner (see notes below for KML).",
"min": 0,
"max": "1",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "playingEntity [classCode=PLC determinerCode=INSTANCE].positionText"
}
]
}
},
{
"path": "Location.position.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Location.position.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Location.position.longitude",
"definition": {
"short": "Longitude as expressed in KML",
"formal": "Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).",
"min": 1,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "?? RIM Opted not to map the sub-elements of GPS location) is now an OBS"
}
]
}
},
{
"path": "Location.position.latitude",
"definition": {
"short": "Latitude as expressed in KML",
"formal": "Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).",
"min": 1,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "?? RIM Opted not to map the sub-elements of GPS location) is now an OBS"
}
]
}
},
{
"path": "Location.position.altitude",
"definition": {
"short": "Altitude as expressed in KML",
"formal": "Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "?? RIM Opted not to map the sub-elements of GPS location) is now an OBS"
}
]
}
},
{
"path": "Location.managingOrganization",
"definition": {
"short": "The organization that is responsible for the provisioning and upkeep of the location",
"formal": "The organization that is responsible for the provisioning and upkeep of the location.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "scopingEntity[classCode=ORG determinerKind=INSTANCE]"
}
]
}
},
{
"path": "Location.status",
"definition": {
"short": "active | suspended | inactive",
"formal": "active | suspended | inactive.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "LocationStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/location-status"
}
},
"mapping": [
{
"identity": "rim",
"map": "statusCode"
}
]
}
},
{
"path": "Location.partOf",
"definition": {
"short": "Another Location which this Location is physically part of",
"formal": "Another Location which this Location is physically part of.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Location"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "inboundLink[typeCode=PART].source[classCode=SDLC]"
}
]
}
},
{
"path": "Location.mode",
"definition": {
"short": "instance | kind",
"formal": "Indicates whether a resource instance represents a specific location or a class of locations.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "LocationMode",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/location-mode"
}
},
"mapping": [
{
"identity": "rim",
"map": "playingEntity[classCode=PLC].determinerCode"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "address",
"type": "string",
"documentation": "A (part of the) address of the location",
"xpath": "f:Location/f:address"
},
{
"name": "identifier",
"type": "token",
"documentation": "Unique code or number identifying the location to its users",
"xpath": "f:Location/f:identifier"
},
{
"name": "name",
"type": "string",
"documentation": "A (portion of the) name of the location",
"xpath": "f:Location/f:name"
},
{
"name": "near",
"type": "token",
"documentation": "The coordinates expressed as [lat],[long] (using KML, see notes) to find locations near to (servers may search using a square rather than a circle for efficiency)"
},
{
"name": "near-distance",
"type": "token",
"documentation": "A distance quantity to limit the near search to locations within a specific distance"
},
{
"name": "partof",
"type": "reference",
"documentation": "The location of which this location is a part",
"xpath": "f:Location/f:partOf"
},
{
"name": "status",
"type": "token",
"documentation": "Searches for locations with a specific kind of status",
"xpath": "f:Location/f:status"
},
{
"name": "type",
"type": "token",
"documentation": "A code for the type of location",
"xpath": "f:Location/f:type"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated.\" class=\"dict\" href=\"location-definitions.html#Location\"><b>Location</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Unique code or number identifying the location to its users.\" class=\"dict\" href=\"location-definitions.html#Location.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">\r\n Unique code or number identifying the location to its users</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Name of the location as used by humans. Does not need to be unique.\" class=\"dict\" href=\"location-definitions.html#Location.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Name of the location as used by humans</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Description of the Location, which helps in finding or referencing the place.\" class=\"dict\" href=\"location-definitions.html#Location.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Description of the Location, which helps in finding or referencing the place</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Indicates the type of function performed at the location.\" class=\"dict\" href=\"location-definitions.html#Location.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v3/vs/ServiceDeliveryLocationRoleType/index.html\">Indicates the type of function performed at the location</a><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.\" class=\"dict\" href=\"location-definitions.html#Location.telecom\"><b>telecom</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">Contact details of the location</span><span style=\"color: Gray\"> --></span></telecom>\r\n <<a title=\"Physical location.\" class=\"dict\" href=\"location-definitions.html#Location.address\"><b>address</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Address\">Address</a></span> <span style=\"color: navy\">Physical location</span><span style=\"color: Gray\"> --></span></address>\r\n <<a title=\"Physical form of the location, e.g. building, room, vehicle, road.\" class=\"dict\" href=\"location-definitions.html#Location.physicalType\"><b>physicalType</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-location-physical-type.html\">Physical form of the location</a></span><span style=\"color: Gray\"> --></span></physicalType>\r\n <<a title=\"The absolute geographic location of the Location, expressed in a KML compatible manner (see notes below for KML).\" class=\"dict\" href=\"location-definitions.html#Location.position\"><b>position</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> The absolute geographic location --></span>\r\n <<a title=\"Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).\" class=\"dict\" href=\"location-definitions.html#Location.position.longitude\"><b>longitude</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#decimal\">decimal</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Longitude as expressed in KML</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).\" class=\"dict\" href=\"location-definitions.html#Location.position.latitude\"><b>latitude</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#decimal\">decimal</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Latitude as expressed in KML</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).\" class=\"dict\" href=\"location-definitions.html#Location.position.altitude\"><b>altitude</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#decimal\">decimal</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Altitude as expressed in KML</span><span style=\"color: Gray\"> --></span>\r\n </position>\r\n <<a title=\"The organization that is responsible for the provisioning and upkeep of the location.\" class=\"dict\" href=\"location-definitions.html#Location.managingOrganization\"><b>managingOrganization</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">\r\n The organization that is responsible for the provisioning and upkeep of the location</span><span style=\"color: Gray\"> --></span></managingOrganization>\r\n <<a title=\"active | suspended | inactive (this element modifies the meaning of other elements)\" class=\"dict\" href=\"location-definitions.html#Location.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"location-status.html\">active | suspended | inactive</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Another Location which this Location is physically part of.\" class=\"dict\" href=\"location-definitions.html#Location.partOf\"><b>partOf</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">\r\n Another Location which this Location is physically part of</span><span style=\"color: Gray\"> --></span></partOf>\r\n <<a title=\"Indicates whether a resource instance represents a specific location or a class of locations (this element modifies the meaning of other elements)\" class=\"dict\" href=\"location-definitions.html#Location.mode\"><span style=\"text-decoration: underline\"><b>mode</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"location-mode.html\">instance | kind</a></span><span style=\"color: Gray\"> --></span>\r\n</Location>\r\n</pre></div>"
},
{
"title": "\"media\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/media",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/media.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.\" class=\"dict\" href=\"media-definitions.html#Media\"><b>Media</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Whether the media is a photo (still image), an audio recording, or a video recording.\" class=\"dict\" href=\"media-definitions.html#Media.type\"><b>type</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"media-type.html\">photo | video | audio<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Details of the type of the media - usually, how it was acquired (what type of device). If images sourced from a DICOM system, are wrapped in a Media resource, then this is the modality.\" class=\"dict\" href=\"media-definitions.html#Media.subtype\"><b>subtype</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-media-subtype.html\">The type of acquisition equipment/process<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></subtype>\r\n <<a title=\"Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers.\" class=\"dict\" href=\"media-definitions.html#Media.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Identifier(s) for the image<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"When the media was originally recorded. For video and audio, if the length of the recording is not insignificant, this is the end of the recording.\" class=\"dict\" href=\"media-definitions.html#Media.dateTime\"><b>dateTime</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When the media was taken/recorded (end)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Who/What this Media is a record of.\" class=\"dict\" href=\"media-definitions.html#Media.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"group.html#Group\">Group</a>|<a href=\"device.html#Device\">Device</a>|<a href=\"specimen.html#Specimen\">Specimen</a>)</span> <span style=\"color: navy\">\r\n Who/What this Media is a record of<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"The person who administered the collection of the image.\" class=\"dict\" href=\"media-definitions.html#Media.operator\"><b>operator</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">The person who generated the image<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></operator>\r\n <<a title=\"The name of the imaging view e.g Lateral or Antero-posterior (AP).\" class=\"dict\" href=\"media-definitions.html#Media.view\"><b>view</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-media-view.html\">Imaging view e.g Lateral or Antero-posterior<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></view>\r\n <<a title=\"The name of the device / manufacturer of the device that was used to make the recording.\" class=\"dict\" href=\"media-definitions.html#Media.deviceName\"><b>deviceName</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Name of the device/manufacturer<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Height of the image in pixels(photo/video).\" class=\"dict\" href=\"media-definitions.html#Media.height\"><b>height</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: Height can only be used for a photo or video\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Height of the image in pixels(photo/video)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Width of the image in pixels (photo/video).\" class=\"dict\" href=\"media-definitions.html#Media.width\"><b>width</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: Width can only be used for a photo or video\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Width of the image in pixels (photo/video)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.\" class=\"dict\" href=\"media-definitions.html#Media.frames\"><b>frames</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-3: Frames can only be used for a photo\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Number of frames if > 1 (photo)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The length of the recording in seconds - for audio and video.\" class=\"dict\" href=\"media-definitions.html#Media.length\"><b>length</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-4: Length can only be used for an audio or a video\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Length in seconds (audio / video)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The actual content of the media - inline or by direct reference to the media source file.\" class=\"dict\" href=\"media-definitions.html#Media.content\"><b>content</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Attachment\">Attachment</a></span> <span style=\"color: navy\">Actual Media - reference or data</span><span style=\"color: Gray\"> --></span></content>\r\n</Media>\r\n</pre></div>"
},
"name": "media",
"publisher": "FHIR Project",
"description": "Basic Profile. A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage The Media resource contains photos, videos, and audio recordings. It is used with media acquired or used as part of the healthcare process. Here are some typical usages: \r\n\r\n* Photos of patients and staff for identification purposes\r\n* Photos and videos of diagnostic or care provision procedures for recording purposes \r\n* Storing scans and faxes of paper documents where not enough metadata exists to create a DocumentReference\r\n* Images on diagnostic reports\r\nThe Media resource may contain medical images in a DICOM format. While such images may also be accessible through an ImagingStudy resource, the Media resource enables \"ready for presentation\" access to a specific image. Such images would preferentially be made available in a FHIR ecosystem by the Media.content.url providing a reference to a WADO-RS service to access the image. That WADO-RS service may include rendering the image with annotations and display parameters from an associated DICOM presentation state. Although the Media resource is allowed to contain images collected by a DICOM based system, DICOM images would preferentially be made available in a FHIR ecosystem by provision of a resource with references to a WADO-RS server.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "dicom",
"uri": "http://nema.org/dicom",
"name": "DICOM"
}
],
"structure": [
{
"type": "Media",
"publish": true,
"element": [
{
"path": "Media",
"definition": {
"short": "A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference",
"formal": "A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"constraint": [
{
"key": "3",
"name": "Frames rule",
"severity": "error",
"human": "Frames can only be used for a photo",
"xpath": "(f:type/@value='photo') or not(f:frames)"
},
{
"key": "2",
"name": "Width rule",
"severity": "error",
"human": "Width can only be used for a photo or video",
"xpath": "not(f:type/@value='audio') or not(f:width)"
},
{
"key": "1",
"name": "Height rule",
"severity": "error",
"human": "Height can only be used for a photo or video",
"xpath": "not(f:type/@value='audio') or not(f:height)"
},
{
"key": "4",
"name": "Length rule",
"severity": "error",
"human": "Length can only be used for an audio or a video",
"xpath": "not(f:type/@value='photo') or not(f:length)"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Act[classCode=\"DGIMG\", moodCode=\"EVN\"]"
}
]
}
},
{
"path": "Media.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Media.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Media.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "Media.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "Media.type",
"definition": {
"short": "photo | video | audio",
"formal": "Whether the media is a photo (still image), an audio recording, or a video recording.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "MediaType",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/media-type"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
}
},
{
"path": "Media.subtype",
"definition": {
"short": "The type of acquisition equipment/process",
"formal": "Details of the type of the media - usually, how it was acquired (what type of device). If images sourced from a DICOM system, are wrapped in a Media resource, then this is the modality.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "MediaSubtype",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/media-subtype"
}
},
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"
},
{
"identity": "dicom",
"map": "0008,0060 | 0008,1032"
}
]
}
},
{
"path": "Media.identifier",
"definition": {
"short": "Identifier(s) for the image",
"formal": "Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers.",
"comments": "The identifier label and use can be used to determine what kind of identifier it is.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "dicom",
"map": "0008,0018 | ~0008,0050 | 0020,000D | 0020,000E"
}
]
}
},
{
"path": "Media.dateTime",
"definition": {
"short": "When the media was taken/recorded (end)",
"formal": "When the media was originally recorded. For video and audio, if the length of the recording is not insignificant, this is the end of the recording.",
"comments": "For an image including multiple frames, this is the start time.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "dicom",
"map": "0008,0020 + 0008,0030"
}
]
}
},
{
"path": "Media.subject",
"definition": {
"short": "Who/What this Media is a record of",
"formal": "Who/What this Media is a record of.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Group"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Specimen"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=\"SUBJ\"]…"
},
{
"identity": "dicom",
"map": "~0010,0020"
}
]
}
},
{
"path": "Media.operator",
"definition": {
"short": "The person who generated the image",
"formal": "The person who administered the collection of the image.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=\"PERF\"]…"
},
{
"identity": "dicom",
"map": "0008,1060?"
}
]
}
},
{
"path": "Media.view",
"definition": {
"short": "Imaging view e.g Lateral or Antero-posterior",
"formal": "The name of the imaging view e.g Lateral or Antero-posterior (AP).",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "MediaView",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/media-view"
}
},
"mapping": [
{
"identity": "rim",
"map": "DiagnosticImage.subjectOrientationCode"
}
]
}
},
{
"path": "Media.deviceName",
"definition": {
"short": "Name of the device/manufacturer",
"formal": "The name of the device / manufacturer of the device that was used to make the recording.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=\"DEV\"].role.player.Entity[classCode=\"DEV\"].name"
},
{
"identity": "dicom",
"map": "0008,0070"
}
]
}
},
{
"path": "Media.height",
"definition": {
"short": "Height of the image in pixels(photo/video)",
"formal": "Height of the image in pixels(photo/video).",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"<CODE>\"].value"
},
{
"identity": "dicom",
"map": "0028,0010"
}
]
}
},
{
"path": "Media.width",
"definition": {
"short": "Width of the image in pixels (photo/video)",
"formal": "Width of the image in pixels (photo/video).",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"<CODE>\"].value"
},
{
"identity": "dicom",
"map": "0028,0011"
}
]
}
},
{
"path": "Media.frames",
"definition": {
"short": "Number of frames if > 1 (photo)",
"formal": "The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"<CODE>\"].value"
}
]
}
},
{
"path": "Media.length",
"definition": {
"short": "Length in seconds (audio / video)",
"formal": "The length of the recording in seconds - for audio and video.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"<CODE>\"].value"
},
{
"identity": "dicom",
"map": "~0028,0002"
}
]
}
},
{
"path": "Media.content",
"definition": {
"short": "Actual Media - reference or data",
"formal": "The actual content of the media - inline or by direct reference to the media source file.",
"comments": "Recommended content types: image/jpeg, image/png, image/tiff, video/mpeg, audio/mp4, application/dicom. Application/dicom can contain the transfer syntax as a parameter.",
"min": 1,
"max": "1",
"type": [
{
"code": "Attachment"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".text"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "date",
"type": "date",
"documentation": "When the media was taken/recorded (end)",
"xpath": "f:Media/f:dateTime"
},
{
"name": "identifier",
"type": "token",
"documentation": "Identifier(s) for the image",
"xpath": "f:Media/f:identifier"
},
{
"name": "operator",
"type": "reference",
"documentation": "The person who generated the image",
"xpath": "f:Media/f:operator"
},
{
"name": "subject",
"type": "reference",
"documentation": "Who/What this Media is a record of",
"xpath": "f:Media/f:subject"
},
{
"name": "subtype",
"type": "token",
"documentation": "The type of acquisition equipment/process",
"xpath": "f:Media/f:subtype"
},
{
"name": "type",
"type": "token",
"documentation": "photo | video | audio",
"xpath": "f:Media/f:type"
},
{
"name": "view",
"type": "token",
"documentation": "Imaging view e.g Lateral or Antero-posterior",
"xpath": "f:Media/f:view"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.\" class=\"dict\" href=\"media-definitions.html#Media\"><b>Media</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Whether the media is a photo (still image), an audio recording, or a video recording.\" class=\"dict\" href=\"media-definitions.html#Media.type\"><b>type</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"media-type.html\">photo | video | audio<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Details of the type of the media - usually, how it was acquired (what type of device). If images sourced from a DICOM system, are wrapped in a Media resource, then this is the modality.\" class=\"dict\" href=\"media-definitions.html#Media.subtype\"><b>subtype</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-media-subtype.html\">The type of acquisition equipment/process<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></subtype>\r\n <<a title=\"Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers.\" class=\"dict\" href=\"media-definitions.html#Media.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Identifier(s) for the image<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"When the media was originally recorded. For video and audio, if the length of the recording is not insignificant, this is the end of the recording.\" class=\"dict\" href=\"media-definitions.html#Media.dateTime\"><b>dateTime</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When the media was taken/recorded (end)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Who/What this Media is a record of.\" class=\"dict\" href=\"media-definitions.html#Media.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"group.html#Group\">Group</a>|<a href=\"device.html#Device\">Device</a>|<a href=\"specimen.html#Specimen\">Specimen</a>)</span> <span style=\"color: navy\">\r\n Who/What this Media is a record of<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"The person who administered the collection of the image.\" class=\"dict\" href=\"media-definitions.html#Media.operator\"><b>operator</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">The person who generated the image<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></operator>\r\n <<a title=\"The name of the imaging view e.g Lateral or Antero-posterior (AP).\" class=\"dict\" href=\"media-definitions.html#Media.view\"><b>view</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-media-view.html\">Imaging view e.g Lateral or Antero-posterior<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></view>\r\n <<a title=\"The name of the device / manufacturer of the device that was used to make the recording.\" class=\"dict\" href=\"media-definitions.html#Media.deviceName\"><b>deviceName</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Name of the device/manufacturer<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Height of the image in pixels(photo/video).\" class=\"dict\" href=\"media-definitions.html#Media.height\"><b>height</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: Height can only be used for a photo or video\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Height of the image in pixels(photo/video)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Width of the image in pixels (photo/video).\" class=\"dict\" href=\"media-definitions.html#Media.width\"><b>width</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: Width can only be used for a photo or video\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Width of the image in pixels (photo/video)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.\" class=\"dict\" href=\"media-definitions.html#Media.frames\"><b>frames</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-3: Frames can only be used for a photo\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Number of frames if > 1 (photo)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The length of the recording in seconds - for audio and video.\" class=\"dict\" href=\"media-definitions.html#Media.length\"><b>length</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-4: Length can only be used for an audio or a video\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Length in seconds (audio / video)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The actual content of the media - inline or by direct reference to the media source file.\" class=\"dict\" href=\"media-definitions.html#Media.content\"><b>content</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Attachment\">Attachment</a></span> <span style=\"color: navy\">Actual Media - reference or data</span><span style=\"color: Gray\"> --></span></content>\r\n</Media>\r\n</pre></div>"
},
{
"title": "\"medication\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/medication",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/medication.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"Primarily used for identification and definition of Medication, but also covers ingredients and packaging.\" class=\"dict\" href=\"medication-definitions.html#Medication\"><b>Medication</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"The common/commercial name of the medication absent information such as strength, form, etc. E.g. Acetaminophen, Tylenol 3, etc. The fully coordinated name is communicated as the display of Medication.code.\" class=\"dict\" href=\"medication-definitions.html#Medication.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Common / Commercial name<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A code (or set of codes) that identify this medication. Usage note: This could be a standard drug code such as a drug regulator code, RxNorm code, SNOMED CT code, etc. It could also be a local formulary code, optionally with translations to the standard drug codes.\" class=\"dict\" href=\"medication-definitions.html#Medication.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-medication-codes.html\">Codes that identify this medication<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"Set to true if the item is attributable to a specific manufacturer (even if we don't know who that is).\" class=\"dict\" href=\"medication-definitions.html#Medication.isBrand\"><b>isBrand</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">True if a brand<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Describes the details of the manufacturer.\" class=\"dict\" href=\"medication-definitions.html#Medication.manufacturer\"><b>manufacturer</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">Manufacturer of the item<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></manufacturer>\r\n <<a title=\"Medications are either a single administrable product or a package that contains one or more products.\" class=\"dict\" href=\"medication-definitions.html#Medication.kind\"><b>kind</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"medication-kind.html\">product | package<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Information that only applies to products (not packages).\" class=\"dict\" href=\"medication-definitions.html#Medication.product\"><b>product</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> Administrable medication details --></span>\r\n <<a title=\"Describes the form of the item. Powder; tables; carton.\" class=\"dict\" href=\"medication-definitions.html#Medication.product.form\"><b>form</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-medication-form-codes.html\">powder | tablets | carton +</a></span><span style=\"color: Gray\"> --></span></form>\r\n <<a title=\"Identifies a particular constituent of interest in the product.\" class=\"dict\" href=\"medication-definitions.html#Medication.product.ingredient\"><b>ingredient</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Active or inactive ingredient --></span>\r\n <<a title=\"The actual ingredient - either a substance (simple ingredient) or another medication.\" class=\"dict\" href=\"medication-definitions.html#Medication.product.ingredient.item\"><b>item</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"substance.html#Substance\">Substance</a>|<a href=\"medication.html#Medication\">Medication</a>)</span> <span style=\"color: navy\">The product contained</span><span style=\"color: Gray\"> --></span></item>\r\n <<a title=\"Specifies how many (or how much) of the items there are in this Medication. E.g. 250 mg per tablet.\" class=\"dict\" href=\"medication-definitions.html#Medication.product.ingredient.amount\"><b>amount</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Ratio\">Ratio</a></span> <span style=\"color: navy\">How much ingredient in product</span><span style=\"color: Gray\"> --></span></amount>\r\n </ingredient>\r\n </product>\r\n <<a title=\"Information that only applies to packages (not products).\" class=\"dict\" href=\"medication-definitions.html#Medication.package\"><b>package</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> Details about packaged medications --></span>\r\n <<a title=\"The kind of container that this package comes as.\" class=\"dict\" href=\"medication-definitions.html#Medication.package.container\"><b>container</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-medication-package-form-codes.html\">E.g. box, vial, blister-pack</a></span><span style=\"color: Gray\"> --></span></container>\r\n <<a title=\"A set of components that go to make up the described item.\" class=\"dict\" href=\"medication-definitions.html#Medication.package.content\"><b>content</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> What is in the package? --></span>\r\n <<a title=\"Identifies one of the items in the package.\" class=\"dict\" href=\"medication-definitions.html#Medication.package.content.item\"><b>item</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"medication.html#Medication\">Medication</a>)</span> <span style=\"color: navy\">A product in the package</span><span style=\"color: Gray\"> --></span></item>\r\n <<a title=\"The amount of the product that is in the package.\" class=\"dict\" href=\"medication-definitions.html#Medication.package.content.amount\"><b>amount</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">How many are in the package?</span><span style=\"color: Gray\"> --></span></amount>\r\n </content>\r\n </package>\r\n</Medication>\r\n</pre></div>"
},
"name": "medication",
"publisher": "FHIR Project",
"description": "Basic Profile. Primarily used for identification and definition of Medication, but also covers ingredients and packaging.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage Representing Medication in the majority of healthcare settings is a matter of identifying an item from a list and then conveying a reference for the item selected either into a patient related resource or to other applications. Additional information about the medication is frequently provided for human verification but a full representation of the details of composition and efficacy of the medicine is conveyed by referring to drug dictionaries by means of the codes they define. There are some occasions where it is necessary to identify slightly more detail, such as when dispensing a package containing a particular medicine requires identification both of the medicine and the package at once. There are also some occasions (e.g. custom formulations) where the composition of a medicine must be represented. In these cases the ingredients of the medicine have to be specified together with the amount contained, though the medication resource does not provide full details. \r\n\r\nThe medication resource allows for medications to be characterised as either a product or a package; this classification is important because it affects the interpretation of a prescribed amount. For instance, is the prescribed amount 20 tablets, or 20 packages of 50 tablets each? However the kind element is not required because not all contexts of use are involved with prescription (medication statements, for instance). Typically, however, profiles describing the use of the medication resource in a prescribing environment will make the kind element required. \r\n\r\nDepending on whether the medication is a product or a package, further details about the composition can be provided. A product has a form (tablet, suspension, etc.) and a list of ingredients with quantities. The ingredients may be other medications or substances. A package has a container (vacuum packed box, jar, etc.) and a list of the products or other packages that are in the package.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "Medication",
"publish": true,
"element": [
{
"path": "Medication",
"definition": {
"short": "Definition of a Medication",
"formal": "Primarily used for identification and definition of Medication, but also covers ingredients and packaging.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "ManufacturedProduct[classCode=ADMM]"
}
]
}
},
{
"path": "Medication.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Medication.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Medication.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "Medication.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "Medication.name",
"definition": {
"short": "Common / Commercial name",
"formal": "The common/commercial name of the medication absent information such as strength, form, etc. E.g. Acetaminophen, Tylenol 3, etc. The fully coordinated name is communicated as the display of Medication.code.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".name"
},
{
"identity": "v2",
"map": "RXO-1.2-Requested Give Code.text / RXE-2.2-Give Code.text / RXD-2.2-Dispense/Give Code.text / RXG-4.2-Give Code.text / RXA-5.2-Administered Code.text"
}
]
}
},
{
"path": "Medication.code",
"definition": {
"short": "Codes that identify this medication",
"formal": "A code (or set of codes) that identify this medication. Usage note: This could be a standard drug code such as a drug regulator code, RxNorm code, SNOMED CT code, etc. It could also be a local formulary code, optionally with translations to the standard drug codes.",
"comments": "When defining a medication, the code is the \"identifying\" code for the medication. All the codings provided should be at the same level in the hierarchy (generic, formulation, generic strength, etc.). Codes that relate the medication across the hierarchy should be conveyed using the relationships inherent in Medication.package and Medication.product.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "MedicationFormalRepresentation",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/medication-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "v2",
"map": "RXO-1.1-Requested Give Code.code / RXE-2.1-Give Code.code / RXD-2.1-Dispense/Give Code.code / RXG-4.1-Give Code.code /RXA-5.1-Administered Code.code"
}
]
}
},
{
"path": "Medication.isBrand",
"definition": {
"short": "True if a brand",
"formal": "Set to true if the item is attributable to a specific manufacturer (even if we don't know who that is).",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "true if .player.scopingRole[typeCode=MANU] exists"
}
]
}
},
{
"path": "Medication.manufacturer",
"definition": {
"short": "Manufacturer of the item",
"formal": "Describes the details of the manufacturer.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".player.scopingRole[typeCode=MANU].scoper"
},
{
"identity": "v2",
"map": "RXD-20-Substance Manufacturer Name / RXG-21-Substance Manufacturer Name / RXA-17-Substance Manufacturer Name"
}
]
}
},
{
"path": "Medication.kind",
"definition": {
"short": "product | package",
"formal": "Medications are either a single administrable product or a package that contains one or more products.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "MedicationKind",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/medication-kind"
}
},
"mapping": [
{
"identity": "rim",
"map": ".player.classCode\n(CONT or not)"
}
]
}
},
{
"path": "Medication.product",
"definition": {
"short": "Administrable medication details",
"formal": "Information that only applies to products (not packages).",
"min": 0,
"max": "1",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".player [classCode != CONT]"
}
]
}
},
{
"path": "Medication.product.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Medication.product.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Medication.product.form",
"definition": {
"short": "powder | tablets | carton +",
"formal": "Describes the form of the item. Powder; tables; carton.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "MedicationForm",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/medication-form-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": ".formCode"
},
{
"identity": "v2",
"map": "RXO-5-Requested Dosage Form / RXE-6-Give Dosage Form / RXD-6-Actual Dosage Form / RXG-8-Give Dosage Form / RXA-8-Administered Dosage Form"
}
]
}
},
{
"path": "Medication.product.ingredient",
"definition": {
"short": "Active or inactive ingredient",
"formal": "Identifies a particular constituent of interest in the product.",
"comments": "The ingredients need not be a complete list; usually only active ingredients are listed.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".scopesRole[typeCode=INGR]"
}
]
}
},
{
"path": "Medication.product.ingredient.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Medication.product.ingredient.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Medication.product.ingredient.item",
"definition": {
"short": "The product contained",
"formal": "The actual ingredient - either a substance (simple ingredient) or another medication.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Substance"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Medication"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".player"
},
{
"identity": "v2",
"map": "if substance: RXC-2-Component Code\nif medication: RXO-1-Requested Give Code / RXE-2-Give Code / RXD-2-Dispense/Give Code / RXG-4-Give Code / RXA-5-Administered Code"
}
]
}
},
{
"path": "Medication.product.ingredient.amount",
"definition": {
"short": "How much ingredient in product",
"formal": "Specifies how many (or how much) of the items there are in this Medication. E.g. 250 mg per tablet.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".quantity"
},
{
"identity": "v2",
"map": "if substance: RXC-3-Component Amount & RXC-4-Component Units\nif medication: RXO-2-Requested Give Amount - Minimum & RXO-4-Requested Give Units / RXO-3-Requested Give Amount - Maximum & RXO-4-Requested Give Units / RXO-11-Requested Dispense Amount & RXO-12-Requested Dispense Units / RXE-3-Give Amount - Minimum & RXE-5-Give Units / RXE-4-Give Amount - Maximum & RXE-5-Give Units / RXE-10-Dispense Amount & RXE-10-Dispense Units"
}
]
}
},
{
"path": "Medication.package",
"definition": {
"short": "Details about packaged medications",
"formal": "Information that only applies to packages (not products).",
"min": 0,
"max": "1",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".player[classCode=CONT]"
}
]
}
},
{
"path": "Medication.package.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Medication.package.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Medication.package.container",
"definition": {
"short": "E.g. box, vial, blister-pack",
"formal": "The kind of container that this package comes as.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "MedicationContainer",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/medication-package-form-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
}
},
{
"path": "Medication.package.content",
"definition": {
"short": "What is in the package?",
"formal": "A set of components that go to make up the described item.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".scopesRole[typeCode=CONT]"
}
]
}
},
{
"path": "Medication.package.content.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Medication.package.content.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Medication.package.content.item",
"definition": {
"short": "A product in the package",
"formal": "Identifies one of the items in the package.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Medication"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".player"
}
]
}
},
{
"path": "Medication.package.content.amount",
"definition": {
"short": "How many are in the package?",
"formal": "The amount of the product that is in the package.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".quantity"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "code",
"type": "token",
"documentation": "Codes that identify this medication",
"xpath": "f:Medication/f:code"
},
{
"name": "container",
"type": "token",
"documentation": "E.g. box, vial, blister-pack",
"xpath": "f:Medication/f:package/f:container"
},
{
"name": "content",
"type": "reference",
"documentation": "A product in the package",
"xpath": "f:Medication/f:package/f:content/f:item"
},
{
"name": "form",
"type": "token",
"documentation": "powder | tablets | carton +",
"xpath": "f:Medication/f:product/f:form"
},
{
"name": "ingredient",
"type": "reference",
"documentation": "The product contained",
"xpath": "f:Medication/f:product/f:ingredient/f:item"
},
{
"name": "manufacturer",
"type": "reference",
"documentation": "Manufacturer of the item",
"xpath": "f:Medication/f:manufacturer"
},
{
"name": "name",
"type": "string",
"documentation": "Common / Commercial name",
"xpath": "f:Medication/f:name"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"Primarily used for identification and definition of Medication, but also covers ingredients and packaging.\" class=\"dict\" href=\"medication-definitions.html#Medication\"><b>Medication</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"The common/commercial name of the medication absent information such as strength, form, etc. E.g. Acetaminophen, Tylenol 3, etc. The fully coordinated name is communicated as the display of Medication.code.\" class=\"dict\" href=\"medication-definitions.html#Medication.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Common / Commercial name<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A code (or set of codes) that identify this medication. Usage note: This could be a standard drug code such as a drug regulator code, RxNorm code, SNOMED CT code, etc. It could also be a local formulary code, optionally with translations to the standard drug codes.\" class=\"dict\" href=\"medication-definitions.html#Medication.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-medication-codes.html\">Codes that identify this medication<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"Set to true if the item is attributable to a specific manufacturer (even if we don't know who that is).\" class=\"dict\" href=\"medication-definitions.html#Medication.isBrand\"><b>isBrand</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">True if a brand<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Describes the details of the manufacturer.\" class=\"dict\" href=\"medication-definitions.html#Medication.manufacturer\"><b>manufacturer</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">Manufacturer of the item<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></manufacturer>\r\n <<a title=\"Medications are either a single administrable product or a package that contains one or more products.\" class=\"dict\" href=\"medication-definitions.html#Medication.kind\"><b>kind</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"medication-kind.html\">product | package<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Information that only applies to products (not packages).\" class=\"dict\" href=\"medication-definitions.html#Medication.product\"><b>product</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> Administrable medication details --></span>\r\n <<a title=\"Describes the form of the item. Powder; tables; carton.\" class=\"dict\" href=\"medication-definitions.html#Medication.product.form\"><b>form</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-medication-form-codes.html\">powder | tablets | carton +</a></span><span style=\"color: Gray\"> --></span></form>\r\n <<a title=\"Identifies a particular constituent of interest in the product.\" class=\"dict\" href=\"medication-definitions.html#Medication.product.ingredient\"><b>ingredient</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Active or inactive ingredient --></span>\r\n <<a title=\"The actual ingredient - either a substance (simple ingredient) or another medication.\" class=\"dict\" href=\"medication-definitions.html#Medication.product.ingredient.item\"><b>item</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"substance.html#Substance\">Substance</a>|<a href=\"medication.html#Medication\">Medication</a>)</span> <span style=\"color: navy\">The product contained</span><span style=\"color: Gray\"> --></span></item>\r\n <<a title=\"Specifies how many (or how much) of the items there are in this Medication. E.g. 250 mg per tablet.\" class=\"dict\" href=\"medication-definitions.html#Medication.product.ingredient.amount\"><b>amount</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Ratio\">Ratio</a></span> <span style=\"color: navy\">How much ingredient in product</span><span style=\"color: Gray\"> --></span></amount>\r\n </ingredient>\r\n </product>\r\n <<a title=\"Information that only applies to packages (not products).\" class=\"dict\" href=\"medication-definitions.html#Medication.package\"><b>package</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> Details about packaged medications --></span>\r\n <<a title=\"The kind of container that this package comes as.\" class=\"dict\" href=\"medication-definitions.html#Medication.package.container\"><b>container</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-medication-package-form-codes.html\">E.g. box, vial, blister-pack</a></span><span style=\"color: Gray\"> --></span></container>\r\n <<a title=\"A set of components that go to make up the described item.\" class=\"dict\" href=\"medication-definitions.html#Medication.package.content\"><b>content</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> What is in the package? --></span>\r\n <<a title=\"Identifies one of the items in the package.\" class=\"dict\" href=\"medication-definitions.html#Medication.package.content.item\"><b>item</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"medication.html#Medication\">Medication</a>)</span> <span style=\"color: navy\">A product in the package</span><span style=\"color: Gray\"> --></span></item>\r\n <<a title=\"The amount of the product that is in the package.\" class=\"dict\" href=\"medication-definitions.html#Medication.package.content.amount\"><b>amount</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">How many are in the package?</span><span style=\"color: Gray\"> --></span></amount>\r\n </content>\r\n </package>\r\n</Medication>\r\n</pre></div>"
},
{
"title": "\"medicationadministration\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/medicationadministration",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/medicationadministration.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"Describes the event of a patient being given a dose of a medication. This may be as simple as swallowing a tablet or it may be a long running infusion.\n\nRelated resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration\"><b>MedicationAdministration</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"External identifier - FHIR will generate its own internal IDs (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.identifier\"><span style=\"text-decoration: underline\"><b>identifier</b></span></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">External identifier</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Will generally be set to show that the administration has been completed. For some long running administrations such as infusions it is possible for an administration to be started but not completed or it may be paused while some other process is under way (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"medication-admin-status.html\">in progress | on hold | completed | entered in error | stopped</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The person or animal to whom the medication was given.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.patient\"><b>patient</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Who received medication?</span><span style=\"color: Gray\"> --></span></patient>\r\n <<a title=\"The individual who was responsible for giving the medication to the patient.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.practitioner\"><b>practitioner</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">Who administered substance?</span><span style=\"color: Gray\"> --></span></practitioner>\r\n <<a title=\"The visit or admission the or other contact between patient and health care provider the medication administration was performed as part of.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.encounter\"><b>encounter</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"encounter.html#Encounter\">Encounter</a>)</span> <span style=\"color: navy\">Encounter administered as part of</span><span style=\"color: Gray\"> --></span></encounter>\r\n <<a title=\"The original request, instruction or authority to perform the administration.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.prescription\"><b>prescription</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"medicationprescription.html#MedicationPrescription\">MedicationPrescription</a>)</span> <span style=\"color: navy\">\r\n Order administration performed against</span><span style=\"color: Gray\"> --></span></prescription>\r\n <<a title=\"Set this to true if the record is saying that the medication was NOT administered (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.wasNotGiven\"><span style=\"text-decoration: underline\"><b>wasNotGiven</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">True if medication not administered</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A code indicating why the administration was not performed.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.reasonNotGiven\"><b>reasonNotGiven</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: Reason not given is only permitted if wasNotGiven is true\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-reason-medication-not-given-codes.html\">Reason administration not performed</a></span><span style=\"color: Gray\"> --></span></reasonNotGiven>\r\n <<a title=\"An interval of time during which the administration took place. For many administrations, such as swallowing a tablet the lower and upper values of the interval will be the same.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.whenGiven\"><b>whenGiven</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">Start and end time of administration</span><span style=\"color: Gray\"> --></span></whenGiven>\r\n <<a title=\"Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.medication\"><b>medication</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"medication.html#Medication\">Medication</a>)</span> <span style=\"color: navy\">What was administered?</span><span style=\"color: Gray\"> --></span></medication>\r\n <<a title=\"The device used in administering the medication to the patient. E.g. a particular infusion pump.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.device\"><b>device</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"device.html#Device\">Device</a>)</span> <span style=\"color: navy\">Device used to administer</span><span style=\"color: Gray\"> --></span></device>\r\n <<a title=\"Provides details of how much of the medication was administered.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.dosage\"><b>dosage</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Medicine administration instructions to the patient/carer --></span>\r\n <<a title=\"The timing schedule for giving the medication to the patient. This may be a single time point (using dateTime) or it may be a start and end dateTime (Period).\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.dosage.timing_x_\"><b>timing[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a>|<a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">When dose(s) were given</span><span style=\"color: Gray\"> --></span></timing[x]>\r\n <<a title=\"If set to true or if specified as a CodeableConcept, indicates that the medication is only taken when needed within the specified schedule rather than at every scheduled dose. If a CodeableConcept is present, it indicates the pre-condition for taking the Medication.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.dosage.asNeeded_x_\"><b>asNeeded[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a>|<a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Take "as needed" f(or x)</span><span style=\"color: Gray\"> --></span></asNeeded[x]>\r\n <<a title=\"A coded specification of the anatomic site where the medication first entered the body. E.g. "left arm".\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.dosage.site\"><b>site</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-approach-site-codes.html\">Body site administered to</a></span><span style=\"color: Gray\"> --></span></site>\r\n <<a title=\"A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. E.g. topical, intravenous, etc.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.dosage.route\"><b>route</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-route-codes.html\">Path of substance into body</a></span><span style=\"color: Gray\"> --></span></route>\r\n <<a title=\"A coded value indicating the method by which the medication was introduced into or onto the body. Most commonly used for injections. Examples: Slow Push; Deep IV.\n\nTerminologies used often pre-coordinate this term with the route and or form of administration.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.dosage.method\"><b>method</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administration-method-codes.html\">How drug was administered</a></span><span style=\"color: Gray\"> --></span></method>\r\n <<a title=\"The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.dosage.quantity\"><b>quantity</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">Amount administered in one dose</span><span style=\"color: Gray\"> --></span></quantity>\r\n <<a title=\"Identifies the speed with which the medication was introduced into the patient. Typically the rate for an infusion e.g. 200ml in 2 hours. May also expressed as a rate per unit of time such as 100ml per hour - the duration is then not specified, or is specified in the quantity.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.dosage.rate\"><b>rate</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Ratio\">Ratio</a></span> <span style=\"color: navy\">Dose quantity per unit of time</span><span style=\"color: Gray\"> --></span></rate>\r\n <<a title=\"The maximum total quantity of a therapeutic substance that was administered to the patient over the specified period of time. E.g. 1000mg in 24 hours.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.dosage.maxDosePerPeriod\"><b>maxDosePerPeriod</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Ratio\">Ratio</a></span> <span style=\"color: navy\">Total dose that was consumed per unit of time</span><span style=\"color: Gray\"> --></span></maxDosePerPeriod>\r\n </dosage>\r\n</MedicationAdministration>\r\n</pre></div>"
},
"name": "medicationadministration",
"publisher": "FHIR Project",
"description": "Basic Profile. Describes the event of a patient being given a dose of a medication. This may be as simple as swallowing a tablet or it may be a long running infusion.\n\nRelated resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage This resource covers the administration of all medications with the exception of vaccines. It will principally be used within inpatient settings to record the capture of medication administrations including self-administrations of oral medications, injections, intra-venous adjustments, etc. It can also be used in out-patient settings to record allergy shots and other non-immunization administrations. In some cases it might be used for home-health reporting, such as recording self-administered or even device-administered insulin.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "MedicationAdministration",
"publish": true,
"element": [
{
"path": "MedicationAdministration",
"definition": {
"short": "Administration of medication to a patient",
"formal": "Describes the event of a patient being given a dose of a medication. This may be as simple as swallowing a tablet or it may be a long running infusion.\n\nRelated resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"constraint": [
{
"key": "2",
"name": "Not given reason",
"severity": "error",
"human": "Reason not given is only permitted if wasNotGiven is true",
"xpath": "not(exists(f:reasonNotGiven)) or f:wasNotGiven='true'"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "SubstanceAdministration"
}
]
}
},
{
"path": "MedicationAdministration.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MedicationAdministration.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MedicationAdministration.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "MedicationAdministration.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "MedicationAdministration.identifier",
"definition": {
"short": "External identifier",
"formal": "External identifier - FHIR will generate its own internal IDs (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "id"
},
{
"identity": "v2",
"map": "RXA-25-Administered Barcode Identifier? (V2 def'n of RXA-25 refers to the 'give' occurrence; appears not to discuss 'administer' cardinality which would seem to be 0..*)"
}
]
}
},
{
"path": "MedicationAdministration.status",
"definition": {
"short": "in progress | on hold | completed | entered in error | stopped",
"formal": "Will generally be set to show that the administration has been completed. For some long running administrations such as infusions it is possible for an administration to be started but not completed or it may be paused while some other process is under way.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "MedicationAdministrationStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/medication-admin-status"
}
},
"mapping": [
{
"identity": "rim",
"map": "statusCode"
},
{
"identity": "v2",
"map": "RXA-20-Completion Status"
}
]
}
},
{
"path": "MedicationAdministration.patient",
"definition": {
"short": "Who received medication?",
"formal": "The person or animal to whom the medication was given.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "subject->Patient"
},
{
"identity": "v2",
"map": "PID-3-Patient ID List"
}
]
}
},
{
"path": "MedicationAdministration.practitioner",
"definition": {
"short": "Who administered substance?",
"formal": "The individual who was responsible for giving the medication to the patient.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "performer->Role"
},
{
"identity": "v2",
"map": "RXA-10-Administering Provider / PRT-5-Participation Person: PRT-4-Participation='AP' (RXA-10 is deprecated)"
}
]
}
},
{
"path": "MedicationAdministration.encounter",
"definition": {
"short": "Encounter administered as part of",
"formal": "The visit or admission the or other contact between patient and health care provider the medication administration was performed as part of.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Encounter"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "component->EncounterEvent"
},
{
"identity": "v2",
"map": "PV1-19-Visit Number"
}
]
}
},
{
"path": "MedicationAdministration.prescription",
"definition": {
"short": "Order administration performed against",
"formal": "The original request, instruction or authority to perform the administration.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/MedicationPrescription"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "InFullfillmentOf->SubstanceAdministration"
},
{
"identity": "v2",
"map": "ORC-3-Filler Order Number / ORC-2-Placer Order Number"
}
]
}
},
{
"path": "MedicationAdministration.wasNotGiven",
"definition": {
"short": "True if medication not administered",
"formal": "Set this to true if the record is saying that the medication was NOT administered.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "actionNegationInd"
},
{
"identity": "v2",
"map": "RXA-20-Completion Status='NA'"
}
]
}
},
{
"path": "MedicationAdministration.reasonNotGiven",
"definition": {
"short": "Reason administration not performed",
"formal": "A code indicating why the administration was not performed.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "MedicationAdministrationNegationReason",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/reason-medication-not-given-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": "Reason->Observation->Value"
},
{
"identity": "v2",
"map": "RXA-9-Administration Notes:RXA-20-Completion Status='NA'"
}
]
}
},
{
"path": "MedicationAdministration.whenGiven",
"definition": {
"short": "Start and end time of administration",
"formal": "An interval of time during which the administration took place. For many administrations, such as swallowing a tablet the lower and upper values of the interval will be the same.",
"min": 1,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "effectiveTime"
},
{
"identity": "v2",
"map": "RXA-3-Date/Time Start of Administration / RXA-4-Date/Time End of Administration"
}
]
}
},
{
"path": "MedicationAdministration.medication",
"definition": {
"short": "What was administered?",
"formal": "Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.",
"comments": "Note: do not use Medication.name to describe the administered medication. When the only available information is a text description of the medication, Medication.code.text should be used.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Medication"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Consumeable->AdministerableMedication"
},
{
"identity": "v2",
"map": "RXA-5-Administered Code"
}
]
}
},
{
"path": "MedicationAdministration.device",
"definition": {
"short": "Device used to administer",
"formal": "The device used in administering the medication to the patient. E.g. a particular infusion pump.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "device->Access OR device->AssignedDevice"
},
{
"identity": "v2",
"map": "PRT-10-Participation Device"
}
]
}
},
{
"path": "MedicationAdministration.dosage",
"definition": {
"short": "Medicine administration instructions to the patient/carer",
"formal": "Provides details of how much of the medication was administered.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "1",
"name": "Dose",
"severity": "error",
"human": "SHALL have at least one of dosage.quantity and dosage.rate",
"xpath": "exists(f:quantity) or exists(f:rate)"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "component->SubstanceAdministrationEvent"
}
]
}
},
{
"path": "MedicationAdministration.dosage.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MedicationAdministration.dosage.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MedicationAdministration.dosage.timing[x]",
"definition": {
"short": "When dose(s) were given",
"formal": "The timing schedule for giving the medication to the patient. This may be a single time point (using dateTime) or it may be a start and end dateTime (Period).",
"comments": "This is generally only relevant if the administration record represents a summary of multiple administrations.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "effectiveTime[TS or IVL_TS)"
},
{
"identity": "v2",
"map": "RAS:TQ1"
}
]
}
},
{
"path": "MedicationAdministration.dosage.asNeeded[x]",
"definition": {
"short": "Take \"as needed\" f(or x)",
"formal": "If set to true or if specified as a CodeableConcept, indicates that the medication is only taken when needed within the specified schedule rather than at every scheduled dose. If a CodeableConcept is present, it indicates the pre-condition for taking the Medication.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
},
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "MedicationAsNeededReason",
"isExtensible": true,
"conformance": "preferred",
"description": "A coded concept identifying the pre-condition that should hold prior to consuming a medication dose. For example \"pain\", \"30 minutes prior to sexual intercourse\", \"on flare-up\", etc."
},
"mapping": [
{
"identity": "rim",
"map": "boolean: precondition.negationInd (inversed - so negationInd = true means asNeeded=false\n\nCodeableConcept: precondition.observationEventCriterion[code=\"Assertion\"].value"
}
]
}
},
{
"path": "MedicationAdministration.dosage.site",
"definition": {
"short": "Body site administered to",
"formal": "A coded specification of the anatomic site where the medication first entered the body. E.g. \"left arm\".",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "MedicationAdministrationSite",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/approach-site-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": "approachSiteCode"
},
{
"identity": "v2",
"map": "RXR-2-Administration Site"
}
]
}
},
{
"path": "MedicationAdministration.dosage.route",
"definition": {
"short": "Path of substance into body",
"formal": "A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. E.g. topical, intravenous, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "RouteOfAdministration",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/route-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": "routeCode"
},
{
"identity": "v2",
"map": "RXR-1-Route"
}
]
}
},
{
"path": "MedicationAdministration.dosage.method",
"definition": {
"short": "How drug was administered",
"formal": "A coded value indicating the method by which the medication was introduced into or onto the body. Most commonly used for injections. Examples: Slow Push; Deep IV.\n\nTerminologies used often pre-coordinate this term with the route and or form of administration.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "MedicationAdministrationMethod",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/administration-method-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": "methodCode"
},
{
"identity": "v2",
"map": "RXR-4-Administration Method"
}
]
}
},
{
"path": "MedicationAdministration.dosage.quantity",
"definition": {
"short": "Amount administered in one dose",
"formal": "The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection.",
"comments": "If the administration is not instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount administered over period of time of a single administration (as indicated by schedule).",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "doseQuantity"
},
{
"identity": "v2",
"map": "RXA-6-Administered Amount / RXA-7.1-Administered Units.code / RXA-7.3-Administered Units.name of coding system (uri<->code system mapping required)"
}
]
}
},
{
"path": "MedicationAdministration.dosage.rate",
"definition": {
"short": "Dose quantity per unit of time",
"formal": "Identifies the speed with which the medication was introduced into the patient. Typically the rate for an infusion e.g. 200ml in 2 hours. May also expressed as a rate per unit of time such as 100ml per hour - the duration is then not specified, or is specified in the quantity.",
"comments": "If the rate changes over time, each change should be captured as a distinct \"dosage\" repetition. This element should *not* be used to convey an average rate.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "rateQuantity"
},
{
"identity": "v2",
"map": "RXA-12-Administered Per (Time Unit)"
}
]
}
},
{
"path": "MedicationAdministration.dosage.maxDosePerPeriod",
"definition": {
"short": "Total dose that was consumed per unit of time",
"formal": "The maximum total quantity of a therapeutic substance that was administered to the patient over the specified period of time. E.g. 1000mg in 24 hours.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "maxDoseQuantity"
},
{
"identity": "v2",
"map": "RXE-4-Give Amount - Maximum / RXE-5-Give Units"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "device",
"type": "reference",
"documentation": "Return administrations with this administration device identity",
"xpath": "f:MedicationAdministration/f:device"
},
{
"name": "encounter",
"type": "reference",
"documentation": "Return administrations that share this encounter",
"xpath": "f:MedicationAdministration/f:encounter"
},
{
"name": "identifier",
"type": "token",
"documentation": "Return administrations with this external identity",
"xpath": "f:MedicationAdministration/f:identifier"
},
{
"name": "medication",
"type": "reference",
"documentation": "Return administrations of this medication",
"xpath": "f:MedicationAdministration/f:medication"
},
{
"name": "notgiven",
"type": "token",
"documentation": "Administrations that were not made",
"xpath": "f:MedicationAdministration/f:wasNotGiven"
},
{
"name": "patient",
"type": "reference",
"documentation": "The identity of a patient to list administrations for",
"xpath": "f:MedicationAdministration/f:patient"
},
{
"name": "prescription",
"type": "reference",
"documentation": "The identity of a prescription to list administrations from",
"xpath": "f:MedicationAdministration/f:prescription"
},
{
"name": "status",
"type": "token",
"documentation": "MedicationAdministration event status (for example one of active/paused/completed/nullified)",
"xpath": "f:MedicationAdministration/f:status"
},
{
"name": "whengiven",
"type": "date",
"documentation": "Date of administration",
"xpath": "f:MedicationAdministration/f:whenGiven"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"Describes the event of a patient being given a dose of a medication. This may be as simple as swallowing a tablet or it may be a long running infusion.\n\nRelated resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration\"><b>MedicationAdministration</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"External identifier - FHIR will generate its own internal IDs (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.identifier\"><span style=\"text-decoration: underline\"><b>identifier</b></span></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">External identifier</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Will generally be set to show that the administration has been completed. For some long running administrations such as infusions it is possible for an administration to be started but not completed or it may be paused while some other process is under way (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"medication-admin-status.html\">in progress | on hold | completed | entered in error | stopped</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The person or animal to whom the medication was given.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.patient\"><b>patient</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Who received medication?</span><span style=\"color: Gray\"> --></span></patient>\r\n <<a title=\"The individual who was responsible for giving the medication to the patient.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.practitioner\"><b>practitioner</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">Who administered substance?</span><span style=\"color: Gray\"> --></span></practitioner>\r\n <<a title=\"The visit or admission the or other contact between patient and health care provider the medication administration was performed as part of.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.encounter\"><b>encounter</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"encounter.html#Encounter\">Encounter</a>)</span> <span style=\"color: navy\">Encounter administered as part of</span><span style=\"color: Gray\"> --></span></encounter>\r\n <<a title=\"The original request, instruction or authority to perform the administration.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.prescription\"><b>prescription</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"medicationprescription.html#MedicationPrescription\">MedicationPrescription</a>)</span> <span style=\"color: navy\">\r\n Order administration performed against</span><span style=\"color: Gray\"> --></span></prescription>\r\n <<a title=\"Set this to true if the record is saying that the medication was NOT administered (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.wasNotGiven\"><span style=\"text-decoration: underline\"><b>wasNotGiven</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">True if medication not administered</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A code indicating why the administration was not performed.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.reasonNotGiven\"><b>reasonNotGiven</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: Reason not given is only permitted if wasNotGiven is true\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-reason-medication-not-given-codes.html\">Reason administration not performed</a></span><span style=\"color: Gray\"> --></span></reasonNotGiven>\r\n <<a title=\"An interval of time during which the administration took place. For many administrations, such as swallowing a tablet the lower and upper values of the interval will be the same.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.whenGiven\"><b>whenGiven</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">Start and end time of administration</span><span style=\"color: Gray\"> --></span></whenGiven>\r\n <<a title=\"Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.medication\"><b>medication</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"medication.html#Medication\">Medication</a>)</span> <span style=\"color: navy\">What was administered?</span><span style=\"color: Gray\"> --></span></medication>\r\n <<a title=\"The device used in administering the medication to the patient. E.g. a particular infusion pump.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.device\"><b>device</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"device.html#Device\">Device</a>)</span> <span style=\"color: navy\">Device used to administer</span><span style=\"color: Gray\"> --></span></device>\r\n <<a title=\"Provides details of how much of the medication was administered.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.dosage\"><b>dosage</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Medicine administration instructions to the patient/carer --></span>\r\n <<a title=\"The timing schedule for giving the medication to the patient. This may be a single time point (using dateTime) or it may be a start and end dateTime (Period).\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.dosage.timing_x_\"><b>timing[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a>|<a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">When dose(s) were given</span><span style=\"color: Gray\"> --></span></timing[x]>\r\n <<a title=\"If set to true or if specified as a CodeableConcept, indicates that the medication is only taken when needed within the specified schedule rather than at every scheduled dose. If a CodeableConcept is present, it indicates the pre-condition for taking the Medication.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.dosage.asNeeded_x_\"><b>asNeeded[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a>|<a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Take "as needed" f(or x)</span><span style=\"color: Gray\"> --></span></asNeeded[x]>\r\n <<a title=\"A coded specification of the anatomic site where the medication first entered the body. E.g. "left arm".\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.dosage.site\"><b>site</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-approach-site-codes.html\">Body site administered to</a></span><span style=\"color: Gray\"> --></span></site>\r\n <<a title=\"A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. E.g. topical, intravenous, etc.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.dosage.route\"><b>route</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-route-codes.html\">Path of substance into body</a></span><span style=\"color: Gray\"> --></span></route>\r\n <<a title=\"A coded value indicating the method by which the medication was introduced into or onto the body. Most commonly used for injections. Examples: Slow Push; Deep IV.\n\nTerminologies used often pre-coordinate this term with the route and or form of administration.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.dosage.method\"><b>method</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administration-method-codes.html\">How drug was administered</a></span><span style=\"color: Gray\"> --></span></method>\r\n <<a title=\"The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.dosage.quantity\"><b>quantity</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">Amount administered in one dose</span><span style=\"color: Gray\"> --></span></quantity>\r\n <<a title=\"Identifies the speed with which the medication was introduced into the patient. Typically the rate for an infusion e.g. 200ml in 2 hours. May also expressed as a rate per unit of time such as 100ml per hour - the duration is then not specified, or is specified in the quantity.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.dosage.rate\"><b>rate</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Ratio\">Ratio</a></span> <span style=\"color: navy\">Dose quantity per unit of time</span><span style=\"color: Gray\"> --></span></rate>\r\n <<a title=\"The maximum total quantity of a therapeutic substance that was administered to the patient over the specified period of time. E.g. 1000mg in 24 hours.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.dosage.maxDosePerPeriod\"><b>maxDosePerPeriod</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Ratio\">Ratio</a></span> <span style=\"color: navy\">Total dose that was consumed per unit of time</span><span style=\"color: Gray\"> --></span></maxDosePerPeriod>\r\n </dosage>\r\n</MedicationAdministration>\r\n</pre></div>"
},
{
"title": "\"medicationdispense\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/medicationdispense",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/medicationdispense.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"Dispensing a medication to a named patient. This includes a description of the supply provided and the instructions for administering the medication.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense\"><b>MedicationDispense</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.identifier\"><span style=\"text-decoration: underline\"><b>identifier</b></span></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">External identifier</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"A code specifying the state of the set of dispense events (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"medication-dispense-status.html\">in progress | on hold | completed | entered in error | stopped</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A link to a resource representing the person to whom the medication will be given.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.patient\"><b>patient</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Who the dispense is for</span><span style=\"color: Gray\"> --></span></patient>\r\n <<a title=\"The individual responsible for dispensing the medication.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispenser\"><b>dispenser</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">\r\n Practitioner responsible for dispensing medication</span><span style=\"color: Gray\"> --></span></dispenser>\r\n <<a title=\"Indicates the medication order that is being dispensed against.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.authorizingPrescription\"><b>authorizingPrescription</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"medicationprescription.html#MedicationPrescription\">MedicationPrescription</a>)</span> <span style=\"color: navy\">\r\n Medication order that authorizes the dispense</span><span style=\"color: Gray\"> --></span></authorizingPrescription>\r\n <<a title=\"Indicates the details of the dispense event such as the days supply and quantity of medication dispensed.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense\"><b>dispense</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Details for individual dispensed medicationdetails --></span>\r\n <<a title=\"Identifier assigned by the dispensing facility. This is an identifier assigned outside FHIR.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">External identifier for individual item</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"A code specifying the state of the dispense event (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"medication-dispense-status.html\">in progress | on hold | completed | entered in error | stopped</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v3/vs/ActPharmacySupplyType/index.html\">Trial fill, partial fill, emergency fill, etc.</a><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"The amount of medication that has been dispensed. Includes unit of measure.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.quantity\"><b>quantity</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">Amount dispensed</span><span style=\"color: Gray\"> --></span></quantity>\r\n <<a title=\"Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.medication\"><b>medication</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"medication.html#Medication\">Medication</a>)</span> <span style=\"color: navy\">What medication was supplied</span><span style=\"color: Gray\"> --></span></medication>\r\n <<a title=\"The time when the dispensed product was packaged and reviewed.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.whenPrepared\"><b>whenPrepared</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Dispense processing time</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The time the dispensed product was provided to the patient or their representative.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.whenHandedOver\"><b>whenHandedOver</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Handover time</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identification of the facility/location where the medication was shipped to, as part of the dispense event.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.destination\"><b>destination</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">Where the medication was sent</span><span style=\"color: Gray\"> --></span></destination>\r\n <<a title=\"Identifies the person who picked up the medication. This will usually be a patient or their carer, but some cases exist where it can be a healthcare professional.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.receiver\"><b>receiver</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">Who collected the medication</span><span style=\"color: Gray\"> --></span></receiver>\r\n <<a title=\"Indicates how the medication is to be used by the patient.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.dosage\"><b>dosage</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Medicine administration instructions to the patient/carer --></span>\r\n <<a title=\"Additional instructions such as "Swallow with plenty of water" which may or may not be coded.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.dosage.additionalInstructions\"><b>additionalInstructions</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">E.g. "Take with food"</span><span style=\"color: Gray\"> --></span></additionalInstructions>\r\n <<a title=\"The timing schedule for giving the medication to the patient. The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.dosage.timing_x_\"><b>timing[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a>|<a href=\"datatypes.html#Period\">Period</a>|<a href=\"datatypes.html#Schedule\">Schedule</a></span> <span style=\"color: navy\">When medication should be administered</span><span style=\"color: Gray\"> --></span></timing[x]>\r\n <<a title=\"If set to true or if specified as a CodeableConcept, indicates that the medication is only taken when needed within the specified schedule rather than at every scheduled dose. If a CodeableConcept is present, it indicates the pre-condition for taking the Medication.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.dosage.asNeeded_x_\"><b>asNeeded[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a>|<a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Take "as needed" f(or x)</span><span style=\"color: Gray\"> --></span></asNeeded[x]>\r\n <<a title=\"A coded specification of the anatomic site where the medication first enters the body.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.dosage.site\"><b>site</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-approach-site-codes.html\">Body site to administer to</a></span><span style=\"color: Gray\"> --></span></site>\r\n <<a title=\"A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.dosage.route\"><b>route</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-route-codes.html\">How drug should enter body</a></span><span style=\"color: Gray\"> --></span></route>\r\n <<a title=\"A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. Examples: Slow Push; Deep IV.\n\nTerminologies used often pre-coordinate this term with the route and or form of administration.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.dosage.method\"><b>method</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administration-method-codes.html\">Technique for administering medication</a></span><span style=\"color: Gray\"> --></span></method>\r\n <<a title=\"The amount of therapeutic or other substance given at one administration event.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.dosage.quantity\"><b>quantity</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">Amount of medication per dose</span><span style=\"color: Gray\"> --></span></quantity>\r\n <<a title=\"Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.dosage.rate\"><b>rate</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Ratio\">Ratio</a></span> <span style=\"color: navy\">Amount of medication per unit of time</span><span style=\"color: Gray\"> --></span></rate>\r\n <<a title=\"The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time, e.g. 1000mg in 24 hours.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.dosage.maxDosePerPeriod\"><b>maxDosePerPeriod</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Ratio\">Ratio</a></span> <span style=\"color: navy\">Upper limit on medication per unit of time</span><span style=\"color: Gray\"> --></span></maxDosePerPeriod>\r\n </dosage>\r\n </dispense>\r\n <<a title=\"Indicates whether or not substitution was made as part of the dispense. In some cases substitution will be expected but doesn't happen, in other cases substitution is not expected but does happen. This block explains what substitition did or did not happen and why.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.substitution\"><b>substitution</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> Deals with substitution of one medicine for another --></span>\r\n <<a title=\"A code signifying whether a different drug was dispensed from what was prescribed.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.substitution.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v3/vs/ActSubstanceAdminSubstitutionCode/index.html\">Type of substitiution</a><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"Indicates the reason for the substitution of (or lack of substitution) from what was prescribed.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.substitution.reason\"><b>reason</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v3/vs/SubstanceAdminSubstitutionReason/index.html\">Why was substitution made</a><span style=\"color: Gray\"> --></span></reason>\r\n <<a title=\"The person or organization that has primary responsibility for the substitution.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.substitution.responsibleParty\"><b>responsibleParty</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">\r\n Who is responsible for the substitution</span><span style=\"color: Gray\"> --></span></responsibleParty>\r\n </substitution>\r\n</MedicationDispense>\r\n</pre></div>"
},
"name": "medicationdispense",
"publisher": "FHIR Project",
"description": "Basic Profile. Dispensing a medication to a named patient. This includes a description of the supply provided and the instructions for administering the medication.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage This resource covers the supply of all medications to a patient. Examples include dispensing and pick-up from an out-patient pharmacy, dispensing patient-specific medications from in-patient pharmacy to ward as well as issuing a single dose from ward stock to a patient for consumption.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "MedicationDispense",
"publish": true,
"element": [
{
"path": "MedicationDispense",
"definition": {
"short": "Dispensing a medication to a named patient",
"formal": "Dispensing a medication to a named patient. This includes a description of the supply provided and the instructions for administering the medication.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Supply[moodCode=EVN]"
}
]
}
},
{
"path": "MedicationDispense.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MedicationDispense.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MedicationDispense.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "MedicationDispense.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "MedicationDispense.identifier",
"definition": {
"short": "External identifier",
"formal": "Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
}
},
{
"path": "MedicationDispense.status",
"definition": {
"short": "in progress | on hold | completed | entered in error | stopped",
"formal": "A code specifying the state of the set of dispense events.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "MedicationDispenseStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/medication-dispense-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".status"
},
{
"identity": "v2",
"map": "(Not clear whether or how V2 provides for a snapshot of dispense status)"
}
]
}
},
{
"path": "MedicationDispense.patient",
"definition": {
"short": "Who the dispense is for",
"formal": "A link to a resource representing the person to whom the medication will be given.",
"comments": "SubstanceAdministration->subject->Patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=PAT]"
},
{
"identity": "v2",
"map": "PID-3-Patient ID List"
}
]
}
},
{
"path": "MedicationDispense.dispenser",
"definition": {
"short": "Practitioner responsible for dispensing medication",
"formal": "The individual responsible for dispensing the medication.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PFM].role[classCode=ASSIGN]"
},
{
"identity": "v2",
"map": "RXD-10-Dispensing Provider / PRT-5-Participation Person: PRT-4-Participation='DP' (RXD-10 is deprecated)"
}
]
}
},
{
"path": "MedicationDispense.authorizingPrescription",
"definition": {
"short": "Medication order that authorizes the dispense",
"formal": "Indicates the medication order that is being dispensed against.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/MedicationPrescription"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=FLFS].target[moodCode=RQO]"
},
{
"identity": "v2",
"map": "ORC-3-Filler Order Number / ORC-2-Placer Order Number"
}
]
}
},
{
"path": "MedicationDispense.dispense",
"definition": {
"short": "Details for individual dispensed medicationdetails",
"formal": "Indicates the details of the dispense event such as the days supply and quantity of medication dispensed.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "1",
"name": "Timing",
"severity": "error",
"human": "whenHandedOver cannot be before whenPrepared",
"xpath": "not(exists(f:whenHandedOver/@value)) or not(exists(f:whenPrepared/@value)) or ( f:whenHandedOver/@value >= f:whenPrepared/@value)"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=SPLY, moodCode=EVN]"
}
]
}
},
{
"path": "MedicationDispense.dispense.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MedicationDispense.dispense.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MedicationDispense.dispense.identifier",
"definition": {
"short": "External identifier for individual item",
"formal": "Identifier assigned by the dispensing facility. This is an identifier assigned outside FHIR.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
}
},
{
"path": "MedicationDispense.dispense.status",
"definition": {
"short": "in progress | on hold | completed | entered in error | stopped",
"formal": "A code specifying the state of the dispense event.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "MedicationDispenseStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/medication-dispense-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".status"
}
]
}
},
{
"path": "MedicationDispense.dispense.type",
"definition": {
"short": "Trial fill, partial fill, emergency fill, etc.",
"formal": "Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "MedicationDispenseType",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/v3/vs/ActPharmacySupplyType"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "v2",
"map": "RXD-33-Dispense Type"
}
]
}
},
{
"path": "MedicationDispense.dispense.quantity",
"definition": {
"short": "Amount dispensed",
"formal": "The amount of medication that has been dispensed. Includes unit of measure.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".quantity"
},
{
"identity": "v2",
"map": "RXD-4-Actual Dispense Amount / RXD-5.1-Actual Dispense Units.code / RXD-5.3-Actual Dispense Units.name of coding system"
}
]
}
},
{
"path": "MedicationDispense.dispense.medication",
"definition": {
"short": "What medication was supplied",
"formal": "Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.",
"comments": "Note: do not use Medication.name to describe the dispensed medication. When the only available information is a text description of the medication, Medication.code.text should be used.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Medication"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PRD].role"
},
{
"identity": "v2",
"map": "RXD-2-Dispense/Give Code"
}
]
}
},
{
"path": "MedicationDispense.dispense.whenPrepared",
"definition": {
"short": "Dispense processing time",
"formal": "The time when the dispensed product was packaged and reviewed.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime[xmi:type=IVL_TS].low"
},
{
"identity": "v2",
"map": "RXD-3-Date/Time Dispensed"
}
]
}
},
{
"path": "MedicationDispense.dispense.whenHandedOver",
"definition": {
"short": "Handover time",
"formal": "The time the dispensed product was provided to the patient or their representative.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime[xmi:type=IVL_TS].high"
},
{
"identity": "v2",
"map": "RXD-3-Date/Time Dispensed"
}
]
}
},
{
"path": "MedicationDispense.dispense.destination",
"definition": {
"short": "Where the medication was sent",
"formal": "Identification of the facility/location where the medication was shipped to, as part of the dispense event.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Location"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=DST].role"
},
{
"identity": "v2",
"map": "RXD-13-Dispense-to Location; RXD-30-Dispense to Pharmacy; RXD-31-Dispense to Pharmacy Address (V2 (in definition of RXD-13, RXD-30 and RXD-31) directs use of the PRT segment but there doesn't appear to be a standard code in Table 0912 suitable for PRT-4-Participation)"
}
]
}
},
{
"path": "MedicationDispense.dispense.receiver",
"definition": {
"short": "Who collected the medication",
"formal": "Identifies the person who picked up the medication. This will usually be a patient or their carer, but some cases exist where it can be a healthcare professional.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=RCV].role"
}
]
}
},
{
"path": "MedicationDispense.dispense.dosage",
"definition": {
"short": "Medicine administration instructions to the patient/carer",
"formal": "Indicates how the medication is to be used by the patient.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=SBADM, moodCode=INT]"
}
]
}
},
{
"path": "MedicationDispense.dispense.dosage.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MedicationDispense.dispense.dosage.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MedicationDispense.dispense.dosage.additionalInstructions",
"definition": {
"short": "E.g. \"Take with food\"",
"formal": "Additional instructions such as \"Swallow with plenty of water\" which may or may not be coded.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".text"
}
]
}
},
{
"path": "MedicationDispense.dispense.dosage.timing[x]",
"definition": {
"short": "When medication should be administered",
"formal": "The timing schedule for giving the medication to the patient. The Schedule data type allows many different expressions, for example. \"Every 8 hours\"; \"Three times a day\"; \"1/2 an hour before breakfast for 10 days from 23-Dec 2011:\"; \"15 Oct 2013, 17 Oct 2013 and 1 Nov 2013\".",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
},
{
"code": "Schedule"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "v2",
"map": "RDS:TQ1"
}
]
}
},
{
"path": "MedicationDispense.dispense.dosage.asNeeded[x]",
"definition": {
"short": "Take \"as needed\" f(or x)",
"formal": "If set to true or if specified as a CodeableConcept, indicates that the medication is only taken when needed within the specified schedule rather than at every scheduled dose. If a CodeableConcept is present, it indicates the pre-condition for taking the Medication.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
},
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "MedicationAsNeededReason",
"isExtensible": true,
"conformance": "preferred",
"description": "A coded concept identifying the pre-condition that should hold prior to consuming a medication dose. For example \"pain\", \"30 minutes prior to sexual intercourse\", \"on flare-up\", etc."
},
"mapping": [
{
"identity": "rim",
"map": "boolean: .outboundRelationship[typeCode=PRCN].negationInd (inversed - so negationInd = true means asNeeded=false\n\nCodeableConcept: .outboundRelationship[typCode=PRCN].target[classCode=OBS, moodCode=EVN, isCriterionInd=true, code=\"Assertion\"].value"
}
]
}
},
{
"path": "MedicationDispense.dispense.dosage.site",
"definition": {
"short": "Body site to administer to",
"formal": "A coded specification of the anatomic site where the medication first enters the body.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "MedicationAdministrationSite",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/approach-site-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": ".approachSiteCode"
},
{
"identity": "v2",
"map": "RXR-2-Administration Site"
}
]
}
},
{
"path": "MedicationDispense.dispense.dosage.route",
"definition": {
"short": "How drug should enter body",
"formal": "A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "RouteOfAdministration",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/route-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": ".routeCode"
},
{
"identity": "v2",
"map": "RXR-1-Route"
}
]
}
},
{
"path": "MedicationDispense.dispense.dosage.method",
"definition": {
"short": "Technique for administering medication",
"formal": "A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. Examples: Slow Push; Deep IV.\n\nTerminologies used often pre-coordinate this term with the route and or form of administration.",
"comments": "SubstanceAdministration.methodCode.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "MedicationAdministrationMethod",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/administration-method-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": ".methodCode"
},
{
"identity": "v2",
"map": "RXR-4-Administration Method"
}
]
}
},
{
"path": "MedicationDispense.dispense.dosage.quantity",
"definition": {
"short": "Amount of medication per dose",
"formal": "The amount of therapeutic or other substance given at one administration event.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".doseQuantity"
},
{
"identity": "v2",
"map": "RXE-23-Give Rate Amount / RXE-24.1-Give Rate Units.code / RXE-24.3-Give Rate Units.name of coding system"
}
]
}
},
{
"path": "MedicationDispense.dispense.dosage.rate",
"definition": {
"short": "Amount of medication per unit of time",
"formal": "Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".rateQuantity"
},
{
"identity": "v2",
"map": "RXE-22-Give Per (Time Unit)"
}
]
}
},
{
"path": "MedicationDispense.dispense.dosage.maxDosePerPeriod",
"definition": {
"short": "Upper limit on medication per unit of time",
"formal": "The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time, e.g. 1000mg in 24 hours.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".maxDoseQuantity"
},
{
"identity": "v2",
"map": "RXE-4-Give Amount - Maximum / RXE-5-Give Units"
}
]
}
},
{
"path": "MedicationDispense.substitution",
"definition": {
"short": "Deals with substitution of one medicine for another",
"formal": "Indicates whether or not substitution was made as part of the dispense. In some cases substitution will be expected but doesn't happen, in other cases substitution is not expected but does happen. This block explains what substitition did or did not happen and why.",
"min": 0,
"max": "1",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=SUBST, moodCode=EVN]"
}
]
}
},
{
"path": "MedicationDispense.substitution.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MedicationDispense.substitution.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MedicationDispense.substitution.type",
"definition": {
"short": "Type of substitiution",
"formal": "A code signifying whether a different drug was dispensed from what was prescribed.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "MedicationIntendedSubstitutionType",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/v3/vs/ActSubstanceAdminSubstitutionCode"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "v2",
"map": "RXE-9-Substitution Status? (perhaps RXO-9-Allow Substitutions?)"
}
]
}
},
{
"path": "MedicationDispense.substitution.reason",
"definition": {
"short": "Why was substitution made",
"formal": "Indicates the reason for the substitution of (or lack of substitution) from what was prescribed.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "MedicationIntendedSubstitutionReason",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/v3/vs/SubstanceAdminSubstitutionReason"
}
},
"mapping": [
{
"identity": "rim",
"map": ".reasonCode"
}
]
}
},
{
"path": "MedicationDispense.substitution.responsibleParty",
"definition": {
"short": "Who is responsible for the substitution",
"formal": "The person or organization that has primary responsibility for the substitution.",
"comments": "rename.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PFM].role[classCode=ASSIGN]"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "destination",
"type": "reference",
"documentation": "Return dispenses that should be sent to a secific destination",
"xpath": "f:MedicationDispense/f:dispense/f:destination"
},
{
"name": "dispenser",
"type": "reference",
"documentation": "Return all dispenses performed by a specific indiividual",
"xpath": "f:MedicationDispense/f:dispenser"
},
{
"name": "identifier",
"type": "token",
"documentation": "Return dispenses with this external identity",
"xpath": "f:MedicationDispense/f:identifier"
},
{
"name": "medication",
"type": "reference",
"documentation": "Returns dispenses of this medicine",
"xpath": "f:MedicationDispense/f:dispense/f:medication"
},
{
"name": "patient",
"type": "reference",
"documentation": "The identity of a patient to list dispenses for",
"xpath": "f:MedicationDispense/f:patient"
},
{
"name": "prescription",
"type": "reference",
"documentation": "The identity of a prescription to list dispenses from",
"xpath": "f:MedicationDispense/f:authorizingPrescription"
},
{
"name": "responsibleparty",
"type": "reference",
"documentation": "Return all dispenses with the specified responsible party",
"xpath": "f:MedicationDispense/f:substitution/f:responsibleParty"
},
{
"name": "status",
"type": "token",
"documentation": "Status of the dispense",
"xpath": "f:MedicationDispense/f:dispense/f:status"
},
{
"name": "type",
"type": "token",
"documentation": "Return all dispenses of a specific type",
"xpath": "f:MedicationDispense/f:dispense/f:type"
},
{
"name": "whenhandedover",
"type": "date",
"documentation": "Date when medication handed over to patient (outpatient setting), or supplied to ward or clinic (inpatient setting)",
"xpath": "f:MedicationDispense/f:dispense/f:whenHandedOver"
},
{
"name": "whenprepared",
"type": "date",
"documentation": "Date when medication prepared",
"xpath": "f:MedicationDispense/f:dispense/f:whenPrepared"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"Dispensing a medication to a named patient. This includes a description of the supply provided and the instructions for administering the medication.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense\"><b>MedicationDispense</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.identifier\"><span style=\"text-decoration: underline\"><b>identifier</b></span></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">External identifier</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"A code specifying the state of the set of dispense events (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"medication-dispense-status.html\">in progress | on hold | completed | entered in error | stopped</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A link to a resource representing the person to whom the medication will be given.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.patient\"><b>patient</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Who the dispense is for</span><span style=\"color: Gray\"> --></span></patient>\r\n <<a title=\"The individual responsible for dispensing the medication.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispenser\"><b>dispenser</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">\r\n Practitioner responsible for dispensing medication</span><span style=\"color: Gray\"> --></span></dispenser>\r\n <<a title=\"Indicates the medication order that is being dispensed against.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.authorizingPrescription\"><b>authorizingPrescription</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"medicationprescription.html#MedicationPrescription\">MedicationPrescription</a>)</span> <span style=\"color: navy\">\r\n Medication order that authorizes the dispense</span><span style=\"color: Gray\"> --></span></authorizingPrescription>\r\n <<a title=\"Indicates the details of the dispense event such as the days supply and quantity of medication dispensed.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense\"><b>dispense</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Details for individual dispensed medicationdetails --></span>\r\n <<a title=\"Identifier assigned by the dispensing facility. This is an identifier assigned outside FHIR.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">External identifier for individual item</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"A code specifying the state of the dispense event (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"medication-dispense-status.html\">in progress | on hold | completed | entered in error | stopped</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v3/vs/ActPharmacySupplyType/index.html\">Trial fill, partial fill, emergency fill, etc.</a><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"The amount of medication that has been dispensed. Includes unit of measure.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.quantity\"><b>quantity</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">Amount dispensed</span><span style=\"color: Gray\"> --></span></quantity>\r\n <<a title=\"Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.medication\"><b>medication</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"medication.html#Medication\">Medication</a>)</span> <span style=\"color: navy\">What medication was supplied</span><span style=\"color: Gray\"> --></span></medication>\r\n <<a title=\"The time when the dispensed product was packaged and reviewed.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.whenPrepared\"><b>whenPrepared</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Dispense processing time</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The time the dispensed product was provided to the patient or their representative.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.whenHandedOver\"><b>whenHandedOver</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Handover time</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identification of the facility/location where the medication was shipped to, as part of the dispense event.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.destination\"><b>destination</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">Where the medication was sent</span><span style=\"color: Gray\"> --></span></destination>\r\n <<a title=\"Identifies the person who picked up the medication. This will usually be a patient or their carer, but some cases exist where it can be a healthcare professional.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.receiver\"><b>receiver</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">Who collected the medication</span><span style=\"color: Gray\"> --></span></receiver>\r\n <<a title=\"Indicates how the medication is to be used by the patient.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.dosage\"><b>dosage</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Medicine administration instructions to the patient/carer --></span>\r\n <<a title=\"Additional instructions such as "Swallow with plenty of water" which may or may not be coded.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.dosage.additionalInstructions\"><b>additionalInstructions</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">E.g. "Take with food"</span><span style=\"color: Gray\"> --></span></additionalInstructions>\r\n <<a title=\"The timing schedule for giving the medication to the patient. The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.dosage.timing_x_\"><b>timing[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a>|<a href=\"datatypes.html#Period\">Period</a>|<a href=\"datatypes.html#Schedule\">Schedule</a></span> <span style=\"color: navy\">When medication should be administered</span><span style=\"color: Gray\"> --></span></timing[x]>\r\n <<a title=\"If set to true or if specified as a CodeableConcept, indicates that the medication is only taken when needed within the specified schedule rather than at every scheduled dose. If a CodeableConcept is present, it indicates the pre-condition for taking the Medication.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.dosage.asNeeded_x_\"><b>asNeeded[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a>|<a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Take "as needed" f(or x)</span><span style=\"color: Gray\"> --></span></asNeeded[x]>\r\n <<a title=\"A coded specification of the anatomic site where the medication first enters the body.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.dosage.site\"><b>site</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-approach-site-codes.html\">Body site to administer to</a></span><span style=\"color: Gray\"> --></span></site>\r\n <<a title=\"A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.dosage.route\"><b>route</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-route-codes.html\">How drug should enter body</a></span><span style=\"color: Gray\"> --></span></route>\r\n <<a title=\"A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. Examples: Slow Push; Deep IV.\n\nTerminologies used often pre-coordinate this term with the route and or form of administration.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.dosage.method\"><b>method</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administration-method-codes.html\">Technique for administering medication</a></span><span style=\"color: Gray\"> --></span></method>\r\n <<a title=\"The amount of therapeutic or other substance given at one administration event.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.dosage.quantity\"><b>quantity</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">Amount of medication per dose</span><span style=\"color: Gray\"> --></span></quantity>\r\n <<a title=\"Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.dosage.rate\"><b>rate</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Ratio\">Ratio</a></span> <span style=\"color: navy\">Amount of medication per unit of time</span><span style=\"color: Gray\"> --></span></rate>\r\n <<a title=\"The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time, e.g. 1000mg in 24 hours.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.dosage.maxDosePerPeriod\"><b>maxDosePerPeriod</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Ratio\">Ratio</a></span> <span style=\"color: navy\">Upper limit on medication per unit of time</span><span style=\"color: Gray\"> --></span></maxDosePerPeriod>\r\n </dosage>\r\n </dispense>\r\n <<a title=\"Indicates whether or not substitution was made as part of the dispense. In some cases substitution will be expected but doesn't happen, in other cases substitution is not expected but does happen. This block explains what substitition did or did not happen and why.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.substitution\"><b>substitution</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> Deals with substitution of one medicine for another --></span>\r\n <<a title=\"A code signifying whether a different drug was dispensed from what was prescribed.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.substitution.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v3/vs/ActSubstanceAdminSubstitutionCode/index.html\">Type of substitiution</a><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"Indicates the reason for the substitution of (or lack of substitution) from what was prescribed.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.substitution.reason\"><b>reason</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v3/vs/SubstanceAdminSubstitutionReason/index.html\">Why was substitution made</a><span style=\"color: Gray\"> --></span></reason>\r\n <<a title=\"The person or organization that has primary responsibility for the substitution.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.substitution.responsibleParty\"><b>responsibleParty</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">\r\n Who is responsible for the substitution</span><span style=\"color: Gray\"> --></span></responsibleParty>\r\n </substitution>\r\n</MedicationDispense>\r\n</pre></div>"
},
{
"title": "\"medicationprescription\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/medicationprescription",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/medicationprescription.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"An order for both supply of the medication and the instructions for administration of the medicine to a patient.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription\"><b>MedicationPrescription</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"External identifier - one that would be used by another non-FHIR system - for example a re-imbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an erntire workflow process where records have to be tracked through an entire system (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.identifier\"><span style=\"text-decoration: underline\"><b>identifier</b></span></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">External identifier</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"The date (and perhaps time) when the prescription was written.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dateWritten\"><b>dateWritten</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When prescription was authorized</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A code specifying the state of the order. Generally this will be active or completed state (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"medication-prescription-status.html\">active | on hold | completed | entered in error | stopped | superceded</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A link to a resource representing the person to whom the medication will be given.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.patient\"><b>patient</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Who prescription is for</span><span style=\"color: Gray\"> --></span></patient>\r\n <<a title=\"The healthcare professional responsible for authorizing the prescription.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.prescriber\"><b>prescriber</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">Who ordered the medication(s)</span><span style=\"color: Gray\"> --></span></prescriber>\r\n <<a title=\"A link to a resource that identifies the particular occurrence of contact between patient and health care provider.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.encounter\"><b>encounter</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"encounter.html#Encounter\">Encounter</a>)</span> <span style=\"color: navy\">Created during encounter / admission / stay</span><span style=\"color: Gray\"> --></span></encounter>\r\n <<a title=\"Can be the reason or the indication for writing the prescription.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.reason_x_\"><b>reason[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a>|<a href=\"references.html#Resource\">Resource</a>(<a href=\"condition.html#Condition\">Condition</a>)</span> <span style=\"color: navy\">\r\n Reason or indication for writing the prescription</span><span style=\"color: Gray\"> --></span></reason[x]>\r\n <<a title=\"Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.medication\"><b>medication</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"medication.html#Medication\">Medication</a>)</span> <span style=\"color: navy\">Medication to be taken</span><span style=\"color: Gray\"> --></span></medication>\r\n <<a title=\"Indicates how the medication is to be used by the patient.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dosageInstruction\"><b>dosageInstruction</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> How medication should be taken --></span>\r\n <<a title=\"Free text dosage instructions for cases where the instructions are too complex to code.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.text\"><b>text</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Dosage instructions expressed as text</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Additional instructions such as "Swallow with plenty of water" which may or may not be coded.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.additionalInstructions\"><b>additionalInstructions</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">\r\n Supplemental instructions - e.g. "with meals"</span><span style=\"color: Gray\"> --></span></additionalInstructions>\r\n <<a title=\"The timing schedule for giving the medication to the patient. The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.timing_x_\"><b>timing[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a>|<a href=\"datatypes.html#Period\">Period</a>|<a href=\"datatypes.html#Schedule\">Schedule</a></span> <span style=\"color: navy\">When medication should be administered</span><span style=\"color: Gray\"> --></span></timing[x]>\r\n <<a title=\"If set to true or if specified as a CodeableConcept, indicates that the medication is only taken when needed within the specified schedule rather than at every scheduled dose. If a CodeableConcept is present, it indicates the pre-condition for taking the Medication.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.asNeeded_x_\"><b>asNeeded[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a>|<a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Take "as needed" f(or x)</span><span style=\"color: Gray\"> --></span></asNeeded[x]>\r\n <<a title=\"A coded specification of the anatomic site where the medication first enters the body.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.site\"><b>site</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-approach-site-codes.html\">Body site to administer to</a></span><span style=\"color: Gray\"> --></span></site>\r\n <<a title=\"A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.route\"><b>route</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-route-codes.html\">How drug should enter body</a></span><span style=\"color: Gray\"> --></span></route>\r\n <<a title=\"A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. Examples: Slow Push; Deep IV.\n\nTerminologies used often pre-coordinate this term with the route and or form of administration.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.method\"><b>method</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administration-method-codes.html\">Technique for administering medication</a></span><span style=\"color: Gray\"> --></span></method>\r\n <<a title=\"The amount of therapeutic or other substance given at one administration event.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.doseQuantity\"><b>doseQuantity</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">Amount of medication per dose</span><span style=\"color: Gray\"> --></span></doseQuantity>\r\n <<a title=\"Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.rate\"><b>rate</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Ratio\">Ratio</a></span> <span style=\"color: navy\">Amount of medication per unit of time</span><span style=\"color: Gray\"> --></span></rate>\r\n <<a title=\"The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. E.g. 1000mg in 24 hours.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.maxDosePerPeriod\"><b>maxDosePerPeriod</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Ratio\">Ratio</a></span> <span style=\"color: navy\">Upper limit on medication per unit of time</span><span style=\"color: Gray\"> --></span></maxDosePerPeriod>\r\n </dosageInstruction>\r\n <<a title=\"Deals with details of the dispense part of the order.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dispense\"><b>dispense</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> Medication supply authorization --></span>\r\n <<a title=\"Identifies the medication that is to be dispensed. This may be a more specifically defined than the medicationPrescription.medication . This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dispense.medication\"><b>medication</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"medication.html#Medication\">Medication</a>)</span> <span style=\"color: navy\">Product to be supplied</span><span style=\"color: Gray\"> --></span></medication>\r\n <<a title=\"Design Comments: This indicates the validity period of a prescription (stale dating the Prescription) \nIt reflects the prescriber perspective for the validity of the prescription. Dispenses must not be made against the prescription outside of this period. The lower-bound of the Dispensing Window signifies the earliest date that the prescription can be filled for the first time. If an upper-bound is not specified then the Prescription is open-ended or will default to a stale-date based on regulations. \nRationale: Indicates when the Prescription becomes valid, and when it ceases to be a dispensable Prescription.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dispense.validityPeriod\"><b>validityPeriod</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">Time period supply is authorized for</span><span style=\"color: Gray\"> --></span></validityPeriod>\r\n <<a title=\"An integer indicating the number of repeats of the Dispense. \nUsageNotes: For example, the number of times the prescribed quantity is to be supplied including the initial standard fill.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dispense.numberOfRepeatsAllowed\"><b>numberOfRepeatsAllowed</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"># of refills authorized</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The amount that is to be dispensed.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dispense.quantity\"><b>quantity</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">Amount of medication to supply per dispense</span><span style=\"color: Gray\"> --></span></quantity>\r\n <<a title=\"Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last. \nIn some situations, this attribute may be used instead of quantity to identify the amount supplied by how long it is expected to last, rather than the physical quantity issued, e.g. 90 days supply of medication (based on an ordered dosage) When possible, it is always better to specify quantity, as this tends to be more precise. expectedSupplyDuration will always be an estimate that can be influenced by external factors.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dispense.expectedSupplyDuration\"><b>expectedSupplyDuration</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Duration\">Duration</a></span> <span style=\"color: navy\">Days supply per dispense</span><span style=\"color: Gray\"> --></span></expectedSupplyDuration>\r\n </dispense>\r\n <<a title=\"Indicates whether or not substitution can or should be part of the dispense. In some cases substitution must happen, in other cases substitution must not happen, and in others it does not matter. This block explains the prescriber's intent. If nothing is specified substitution may be done.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.substitution\"><b>substitution</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> Any restrictions on medication substitution? --></span>\r\n <<a title=\"A code signifying whether a different drug should be dispensed from what was prescribed.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.substitution.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v3/vs/ActSubstanceAdminSubstitutionCode/index.html\">generic | formulary +</a><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"Indicates the reason for the substitution, or why substitution must or must not be performed.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.substitution.reason\"><b>reason</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v3/vs/SubstanceAdminSubstitutionReason/index.html\">Why should substitution (not) be made</a><span style=\"color: Gray\"> --></span></reason>\r\n </substitution>\r\n</MedicationPrescription>\r\n</pre></div>"
},
"name": "medicationprescription",
"publisher": "FHIR Project",
"description": "Basic Profile. An order for both supply of the medication and the instructions for administration of the medicine to a patient.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage This resource covers all orders for medications for a patient. This includes in-patient medication orders as well as community orders (whether filled by the prescriber or by a pharmacy). It also includes orders for over-the-counter medications (e.g. Aspirin) and dietary supplements. It may be used to support the order of medication-related devices. It is not intended for use in prescribing particular diets, or for ordering non-medication-related items (eye-glasses, supplies, etc.)",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "MedicationPrescription",
"publish": true,
"element": [
{
"path": "MedicationPrescription",
"definition": {
"short": "Prescription of medication to for patient",
"formal": "An order for both supply of the medication and the instructions for administration of the medicine to a patient.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "CombinedMedicationRequest"
}
]
}
},
{
"path": "MedicationPrescription.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MedicationPrescription.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MedicationPrescription.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "MedicationPrescription.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "MedicationPrescription.identifier",
"definition": {
"short": "External identifier",
"formal": "External identifier - one that would be used by another non-FHIR system - for example a re-imbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an erntire workflow process where records have to be tracked through an entire system.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "id"
},
{
"identity": "v2",
"map": "ORC-2-Placer Order Number / ORC-3-Filler Order Number"
}
]
}
},
{
"path": "MedicationPrescription.dateWritten",
"definition": {
"short": "When prescription was authorized",
"formal": "The date (and perhaps time) when the prescription was written.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "author.time"
},
{
"identity": "v2",
"map": "RXE-32-Original Order Date/Time / ORC-9-Date/Time of Transaction"
}
]
}
},
{
"path": "MedicationPrescription.status",
"definition": {
"short": "active | on hold | completed | entered in error | stopped | superceded",
"formal": "A code specifying the state of the order. Generally this will be active or completed state.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "MedicationPrescriptionStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/medication-prescription-status"
}
},
"mapping": [
{
"identity": "rim",
"map": "statusCode"
}
]
}
},
{
"path": "MedicationPrescription.patient",
"definition": {
"short": "Who prescription is for",
"formal": "A link to a resource representing the person to whom the medication will be given.",
"comments": "SubstanceAdministration->subject->Patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "subject.role"
},
{
"identity": "v2",
"map": "PID-3-Patient ID List"
}
]
}
},
{
"path": "MedicationPrescription.prescriber",
"definition": {
"short": "Who ordered the medication(s)",
"formal": "The healthcare professional responsible for authorizing the prescription.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "author.role"
},
{
"identity": "v2",
"map": "RXE-13-Ordering Provider's DEA Number / RXO-14-Ordering Provider's DEA Number / RXE-14-Pharmacist/Treatment Supplier's Verifier ID / RXO-15-Pharmacist/Treatment Supplier's Verifier ID / ORC-12-Ordering Provider / PRT-5-Participation Person: PRT-4-Participation='OP' (all but last deprecated)"
}
]
}
},
{
"path": "MedicationPrescription.encounter",
"definition": {
"short": "Created during encounter / admission / stay",
"formal": "A link to a resource that identifies the particular occurrence of contact between patient and health care provider.",
"comments": "SubstanceAdministration->component->EncounterEvent.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Encounter"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "componentOf.patientEncounter"
},
{
"identity": "v2",
"map": "PV1-19-Visit Number"
}
]
}
},
{
"path": "MedicationPrescription.reason[x]",
"definition": {
"short": "Reason or indication for writing the prescription",
"formal": "Can be the reason or the indication for writing the prescription.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Condition"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "reason.observation\nor\nreason.observation[code=ASSERTION].value"
},
{
"identity": "v2",
"map": "ORC-16-Order Control Code Reason"
}
]
}
},
{
"path": "MedicationPrescription.medication",
"definition": {
"short": "Medication to be taken",
"formal": "Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.",
"comments": "Note: do not use Medication.name to describe the prescribed medication. When the only available information is a text description of the medication, Medication.code.text should be used.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Medication"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "consumable.administrableMedication"
},
{
"identity": "v2",
"map": "RXE-2-Give Code / RXO-1-Requested Give Code / RXD-2-Dispense/Give Code"
}
]
}
},
{
"path": "MedicationPrescription.dosageInstruction",
"definition": {
"short": "How medication should be taken",
"formal": "Indicates how the medication is to be used by the patient.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "component.substanceAdministrationRequest"
}
]
}
},
{
"path": "MedicationPrescription.dosageInstruction.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MedicationPrescription.dosageInstruction.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MedicationPrescription.dosageInstruction.text",
"definition": {
"short": "Dosage instructions expressed as text",
"formal": "Free text dosage instructions for cases where the instructions are too complex to code.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "text"
},
{
"identity": "v2",
"map": "RXE-7.2-Provider's Administration Instructions.text / RXO-7.2-Provider's Administration Instructions.text / TQ1-10-Condition Text / TQ1-11-Text Instruction"
}
]
}
},
{
"path": "MedicationPrescription.dosageInstruction.additionalInstructions",
"definition": {
"short": "Supplemental instructions - e.g. \"with meals\"",
"formal": "Additional instructions such as \"Swallow with plenty of water\" which may or may not be coded.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "component.substanceAdministrationRequest.text"
},
{
"identity": "v2",
"map": "RXE-7.2-Provider's Administration Instructions.text / RXO-7.2-Provider's Administration Instructions.text / TQ1-10-Condition Text / TQ1-11-Text Instruction ?"
}
]
}
},
{
"path": "MedicationPrescription.dosageInstruction.timing[x]",
"definition": {
"short": "When medication should be administered",
"formal": "The timing schedule for giving the medication to the patient. The Schedule data type allows many different expressions, for example. \"Every 8 hours\"; \"Three times a day\"; \"1/2 an hour before breakfast for 10 days from 23-Dec 2011:\"; \"15 Oct 2013, 17 Oct 2013 and 1 Nov 2013\".",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
},
{
"code": "Schedule"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "effectiveTime"
},
{
"identity": "v2",
"map": "RDS:TQ1"
}
]
}
},
{
"path": "MedicationPrescription.dosageInstruction.asNeeded[x]",
"definition": {
"short": "Take \"as needed\" f(or x)",
"formal": "If set to true or if specified as a CodeableConcept, indicates that the medication is only taken when needed within the specified schedule rather than at every scheduled dose. If a CodeableConcept is present, it indicates the pre-condition for taking the Medication.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
},
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "MedicationAsNeededReason",
"isExtensible": true,
"conformance": "preferred",
"description": "A coded concept identifying the pre-condition that should hold prior to consuming a medication dose. For example \"pain\", \"30 minutes prior to sexual intercourse\", \"on flare-up\", etc."
},
"mapping": [
{
"identity": "rim",
"map": "boolean: precondition.negationInd (inversed - so negationInd = true means asNeeded=false\n\nCodeableConcept: precondition.observationEventCriterion[code=\"Assertion\"].value"
}
]
}
},
{
"path": "MedicationPrescription.dosageInstruction.site",
"definition": {
"short": "Body site to administer to",
"formal": "A coded specification of the anatomic site where the medication first enters the body.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "MedicationAdministrationSite",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/approach-site-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": "approachSiteCode"
},
{
"identity": "v2",
"map": "RXR-2-Administration Site"
}
]
}
},
{
"path": "MedicationPrescription.dosageInstruction.route",
"definition": {
"short": "How drug should enter body",
"formal": "A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "RouteOfAdministration",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/route-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": "routeCode"
},
{
"identity": "v2",
"map": "RXR-1-Route"
}
]
}
},
{
"path": "MedicationPrescription.dosageInstruction.method",
"definition": {
"short": "Technique for administering medication",
"formal": "A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. Examples: Slow Push; Deep IV.\n\nTerminologies used often pre-coordinate this term with the route and or form of administration.",
"comments": "SubstanceAdministration.methodCode.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "MedicationAdministrationMethod",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/administration-method-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": "methodCode"
},
{
"identity": "v2",
"map": "RXR-4-Administration Method"
}
]
}
},
{
"path": "MedicationPrescription.dosageInstruction.doseQuantity",
"definition": {
"short": "Amount of medication per dose",
"formal": "The amount of therapeutic or other substance given at one administration event.",
"comments": "Note that this specifies the quantity of the specified medication, not the quantity of active ingredient(s). The prescribed strength can be calculated by multiplying the doseQuantity by the strength of each active ingredient in the prescribed Medication.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "doseQuantity"
},
{
"identity": "v2",
"map": "RXE-23-Give Rate Amount / RXE-24.1-Give Rate Units.code / RXE-24.3-Give Rate Units.name of coding system"
}
]
}
},
{
"path": "MedicationPrescription.dosageInstruction.rate",
"definition": {
"short": "Amount of medication per unit of time",
"formal": "Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "rateQuantity"
},
{
"identity": "v2",
"map": "RXE-22-Give Per (Time Unit)"
}
]
}
},
{
"path": "MedicationPrescription.dosageInstruction.maxDosePerPeriod",
"definition": {
"short": "Upper limit on medication per unit of time",
"formal": "The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. E.g. 1000mg in 24 hours.",
"comments": "This is intended for use as an adjunct to the dosage when there is an upper cap. For example \"2 tablets ever 4 hours to a maximum of 8/day\".",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "maxDoseQuantity"
},
{
"identity": "v2",
"map": "RXE-4-Give Amount - Maximum / RXE-5-Give Units"
}
]
}
},
{
"path": "MedicationPrescription.dispense",
"definition": {
"short": "Medication supply authorization",
"formal": "Deals with details of the dispense part of the order.",
"min": 0,
"max": "1",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "component.supplyEvent"
}
]
}
},
{
"path": "MedicationPrescription.dispense.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MedicationPrescription.dispense.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MedicationPrescription.dispense.medication",
"definition": {
"short": "Product to be supplied",
"formal": "Identifies the medication that is to be dispensed. This may be a more specifically defined than the medicationPrescription.medication . This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Medication"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "consumable.role"
},
{
"identity": "v2",
"map": "RXE-2-Give Code / RXO-1-Requested Give Code / RXD-2-Dispense/Give Code"
}
]
}
},
{
"path": "MedicationPrescription.dispense.validityPeriod",
"definition": {
"short": "Time period supply is authorized for",
"formal": "Design Comments: This indicates the validity period of a prescription (stale dating the Prescription) \nIt reflects the prescriber perspective for the validity of the prescription. Dispenses must not be made against the prescription outside of this period. The lower-bound of the Dispensing Window signifies the earliest date that the prescription can be filled for the first time. If an upper-bound is not specified then the Prescription is open-ended or will default to a stale-date based on regulations. \nRationale: Indicates when the Prescription becomes valid, and when it ceases to be a dispensable Prescription.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "effectiveTime"
},
{
"identity": "v2",
"map": "RXD-3-Date/Time Dispensed ? / RXD-19-Substance Expiration Date"
}
]
}
},
{
"path": "MedicationPrescription.dispense.numberOfRepeatsAllowed",
"definition": {
"short": "# of refills authorized",
"formal": "An integer indicating the number of repeats of the Dispense. \nUsageNotes: For example, the number of times the prescribed quantity is to be supplied including the initial standard fill.",
"comments": "If displaying \"number of authorized refills\", subtract 1 from this number.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "repeatNumber"
},
{
"identity": "v2",
"map": "RXE-12-Number of Refills"
}
]
}
},
{
"path": "MedicationPrescription.dispense.quantity",
"definition": {
"short": "Amount of medication to supply per dispense",
"formal": "The amount that is to be dispensed.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "quantity"
},
{
"identity": "v2",
"map": "RXD-4-Actual Dispense Amount / RXD-5.1-Actual Dispense Units.code / RXD-5.3-Actual Dispense Units.name of coding system"
}
]
}
},
{
"path": "MedicationPrescription.dispense.expectedSupplyDuration",
"definition": {
"short": "Days supply per dispense",
"formal": "Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last. \nIn some situations, this attribute may be used instead of quantity to identify the amount supplied by how long it is expected to last, rather than the physical quantity issued, e.g. 90 days supply of medication (based on an ordered dosage) When possible, it is always better to specify quantity, as this tends to be more precise. expectedSupplyDuration will always be an estimate that can be influenced by external factors.",
"min": 0,
"max": "1",
"type": [
{
"code": "Duration"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "expectedUseTime"
}
]
}
},
{
"path": "MedicationPrescription.substitution",
"definition": {
"short": "Any restrictions on medication substitution?",
"formal": "Indicates whether or not substitution can or should be part of the dispense. In some cases substitution must happen, in other cases substitution must not happen, and in others it does not matter. This block explains the prescriber's intent. If nothing is specified substitution may be done.",
"min": 0,
"max": "1",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "subjectOf.substitutionPersmission"
}
]
}
},
{
"path": "MedicationPrescription.substitution.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MedicationPrescription.substitution.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MedicationPrescription.substitution.type",
"definition": {
"short": "generic | formulary +",
"formal": "A code signifying whether a different drug should be dispensed from what was prescribed.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "MedicationIntendedSubstitutionType",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/v3/vs/ActSubstanceAdminSubstitutionCode"
}
},
"mapping": [
{
"identity": "rim",
"map": "code"
},
{
"identity": "v2",
"map": "RXO-9-Allow Substitutions / RXE-9-Substitution Status?"
}
]
}
},
{
"path": "MedicationPrescription.substitution.reason",
"definition": {
"short": "Why should substitution (not) be made",
"formal": "Indicates the reason for the substitution, or why substitution must or must not be performed.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "MedicationIntendedSubstitutionReason",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/v3/vs/SubstanceAdminSubstitutionReason"
}
},
"mapping": [
{
"identity": "rim",
"map": "reasonCode"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "datewritten",
"type": "date",
"documentation": "Return prescriptions written on this date",
"xpath": "f:MedicationPrescription/f:dateWritten"
},
{
"name": "encounter",
"type": "reference",
"documentation": "Return prescriptions with this encounter identity",
"xpath": "f:MedicationPrescription/f:encounter"
},
{
"name": "identifier",
"type": "token",
"documentation": "Return prescriptions with this external identity",
"xpath": "f:MedicationPrescription/f:identifier"
},
{
"name": "medication",
"type": "reference",
"documentation": "Code for medicine or text in medicine name",
"xpath": "f:MedicationPrescription/f:medication"
},
{
"name": "patient",
"type": "reference",
"documentation": "The identity of a patient to list dispenses for",
"xpath": "f:MedicationPrescription/f:patient"
},
{
"name": "status",
"type": "token",
"documentation": "Status of the prescription",
"xpath": "f:MedicationPrescription/f:status"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"An order for both supply of the medication and the instructions for administration of the medicine to a patient.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription\"><b>MedicationPrescription</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"External identifier - one that would be used by another non-FHIR system - for example a re-imbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an erntire workflow process where records have to be tracked through an entire system (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.identifier\"><span style=\"text-decoration: underline\"><b>identifier</b></span></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">External identifier</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"The date (and perhaps time) when the prescription was written.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dateWritten\"><b>dateWritten</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When prescription was authorized</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A code specifying the state of the order. Generally this will be active or completed state (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"medication-prescription-status.html\">active | on hold | completed | entered in error | stopped | superceded</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A link to a resource representing the person to whom the medication will be given.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.patient\"><b>patient</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Who prescription is for</span><span style=\"color: Gray\"> --></span></patient>\r\n <<a title=\"The healthcare professional responsible for authorizing the prescription.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.prescriber\"><b>prescriber</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">Who ordered the medication(s)</span><span style=\"color: Gray\"> --></span></prescriber>\r\n <<a title=\"A link to a resource that identifies the particular occurrence of contact between patient and health care provider.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.encounter\"><b>encounter</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"encounter.html#Encounter\">Encounter</a>)</span> <span style=\"color: navy\">Created during encounter / admission / stay</span><span style=\"color: Gray\"> --></span></encounter>\r\n <<a title=\"Can be the reason or the indication for writing the prescription.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.reason_x_\"><b>reason[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a>|<a href=\"references.html#Resource\">Resource</a>(<a href=\"condition.html#Condition\">Condition</a>)</span> <span style=\"color: navy\">\r\n Reason or indication for writing the prescription</span><span style=\"color: Gray\"> --></span></reason[x]>\r\n <<a title=\"Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.medication\"><b>medication</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"medication.html#Medication\">Medication</a>)</span> <span style=\"color: navy\">Medication to be taken</span><span style=\"color: Gray\"> --></span></medication>\r\n <<a title=\"Indicates how the medication is to be used by the patient.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dosageInstruction\"><b>dosageInstruction</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> How medication should be taken --></span>\r\n <<a title=\"Free text dosage instructions for cases where the instructions are too complex to code.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.text\"><b>text</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Dosage instructions expressed as text</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Additional instructions such as "Swallow with plenty of water" which may or may not be coded.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.additionalInstructions\"><b>additionalInstructions</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">\r\n Supplemental instructions - e.g. "with meals"</span><span style=\"color: Gray\"> --></span></additionalInstructions>\r\n <<a title=\"The timing schedule for giving the medication to the patient. The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.timing_x_\"><b>timing[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a>|<a href=\"datatypes.html#Period\">Period</a>|<a href=\"datatypes.html#Schedule\">Schedule</a></span> <span style=\"color: navy\">When medication should be administered</span><span style=\"color: Gray\"> --></span></timing[x]>\r\n <<a title=\"If set to true or if specified as a CodeableConcept, indicates that the medication is only taken when needed within the specified schedule rather than at every scheduled dose. If a CodeableConcept is present, it indicates the pre-condition for taking the Medication.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.asNeeded_x_\"><b>asNeeded[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a>|<a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Take "as needed" f(or x)</span><span style=\"color: Gray\"> --></span></asNeeded[x]>\r\n <<a title=\"A coded specification of the anatomic site where the medication first enters the body.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.site\"><b>site</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-approach-site-codes.html\">Body site to administer to</a></span><span style=\"color: Gray\"> --></span></site>\r\n <<a title=\"A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.route\"><b>route</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-route-codes.html\">How drug should enter body</a></span><span style=\"color: Gray\"> --></span></route>\r\n <<a title=\"A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. Examples: Slow Push; Deep IV.\n\nTerminologies used often pre-coordinate this term with the route and or form of administration.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.method\"><b>method</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administration-method-codes.html\">Technique for administering medication</a></span><span style=\"color: Gray\"> --></span></method>\r\n <<a title=\"The amount of therapeutic or other substance given at one administration event.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.doseQuantity\"><b>doseQuantity</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">Amount of medication per dose</span><span style=\"color: Gray\"> --></span></doseQuantity>\r\n <<a title=\"Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.rate\"><b>rate</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Ratio\">Ratio</a></span> <span style=\"color: navy\">Amount of medication per unit of time</span><span style=\"color: Gray\"> --></span></rate>\r\n <<a title=\"The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. E.g. 1000mg in 24 hours.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.maxDosePerPeriod\"><b>maxDosePerPeriod</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Ratio\">Ratio</a></span> <span style=\"color: navy\">Upper limit on medication per unit of time</span><span style=\"color: Gray\"> --></span></maxDosePerPeriod>\r\n </dosageInstruction>\r\n <<a title=\"Deals with details of the dispense part of the order.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dispense\"><b>dispense</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> Medication supply authorization --></span>\r\n <<a title=\"Identifies the medication that is to be dispensed. This may be a more specifically defined than the medicationPrescription.medication . This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dispense.medication\"><b>medication</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"medication.html#Medication\">Medication</a>)</span> <span style=\"color: navy\">Product to be supplied</span><span style=\"color: Gray\"> --></span></medication>\r\n <<a title=\"Design Comments: This indicates the validity period of a prescription (stale dating the Prescription) \nIt reflects the prescriber perspective for the validity of the prescription. Dispenses must not be made against the prescription outside of this period. The lower-bound of the Dispensing Window signifies the earliest date that the prescription can be filled for the first time. If an upper-bound is not specified then the Prescription is open-ended or will default to a stale-date based on regulations. \nRationale: Indicates when the Prescription becomes valid, and when it ceases to be a dispensable Prescription.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dispense.validityPeriod\"><b>validityPeriod</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">Time period supply is authorized for</span><span style=\"color: Gray\"> --></span></validityPeriod>\r\n <<a title=\"An integer indicating the number of repeats of the Dispense. \nUsageNotes: For example, the number of times the prescribed quantity is to be supplied including the initial standard fill.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dispense.numberOfRepeatsAllowed\"><b>numberOfRepeatsAllowed</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"># of refills authorized</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The amount that is to be dispensed.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dispense.quantity\"><b>quantity</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">Amount of medication to supply per dispense</span><span style=\"color: Gray\"> --></span></quantity>\r\n <<a title=\"Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last. \nIn some situations, this attribute may be used instead of quantity to identify the amount supplied by how long it is expected to last, rather than the physical quantity issued, e.g. 90 days supply of medication (based on an ordered dosage) When possible, it is always better to specify quantity, as this tends to be more precise. expectedSupplyDuration will always be an estimate that can be influenced by external factors.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dispense.expectedSupplyDuration\"><b>expectedSupplyDuration</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Duration\">Duration</a></span> <span style=\"color: navy\">Days supply per dispense</span><span style=\"color: Gray\"> --></span></expectedSupplyDuration>\r\n </dispense>\r\n <<a title=\"Indicates whether or not substitution can or should be part of the dispense. In some cases substitution must happen, in other cases substitution must not happen, and in others it does not matter. This block explains the prescriber's intent. If nothing is specified substitution may be done.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.substitution\"><b>substitution</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> Any restrictions on medication substitution? --></span>\r\n <<a title=\"A code signifying whether a different drug should be dispensed from what was prescribed.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.substitution.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v3/vs/ActSubstanceAdminSubstitutionCode/index.html\">generic | formulary +</a><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"Indicates the reason for the substitution, or why substitution must or must not be performed.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.substitution.reason\"><b>reason</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v3/vs/SubstanceAdminSubstitutionReason/index.html\">Why should substitution (not) be made</a><span style=\"color: Gray\"> --></span></reason>\r\n </substitution>\r\n</MedicationPrescription>\r\n</pre></div>"
},
{
"title": "\"medicationstatement\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/medicationstatement",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/medicationstatement.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"A record of medication being taken by a patient, or that the medication has been given to a patient where the record is the result of a report from the patient or another clinician.\" class=\"dict\" href=\"medicationstatement-definitions.html#MedicationStatement\"><b>MedicationStatement</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"External identifier - FHIR will generate its own internal IDs (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationstatement-definitions.html#MedicationStatement.identifier\"><span style=\"text-decoration: underline\"><b>identifier</b></span></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">External Identifier</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"The person or animal who is /was taking the medication.\" class=\"dict\" href=\"medicationstatement-definitions.html#MedicationStatement.patient\"><b>patient</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Who was/is taking medication</span><span style=\"color: Gray\"> --></span></patient>\r\n <<a title=\"Set this to true if the record is saying that the medication was NOT taken.\" class=\"dict\" href=\"medicationstatement-definitions.html#MedicationStatement.wasNotGiven\"><b>wasNotGiven</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">True if medication is/was not being taken</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A code indicating why the medication was not taken.\" class=\"dict\" href=\"medicationstatement-definitions.html#MedicationStatement.reasonNotGiven\"><b>reasonNotGiven</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: Reason not given is only permitted if wasNotGiven is true\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-reason-medication-not-given-codes.html\">True if asserting medication was not given</a></span><span style=\"color: Gray\"> --></span></reasonNotGiven>\r\n <<a title=\"The interval of time during which it is being asserted that the patient was taking the medication.\" class=\"dict\" href=\"medicationstatement-definitions.html#MedicationStatement.whenGiven\"><b>whenGiven</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">Over what period was medication consumed?</span><span style=\"color: Gray\"> --></span></whenGiven>\r\n <<a title=\"Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.\" class=\"dict\" href=\"medicationstatement-definitions.html#MedicationStatement.medication\"><b>medication</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"medication.html#Medication\">Medication</a>)</span> <span style=\"color: navy\">What medication was taken?</span><span style=\"color: Gray\"> --></span></medication>\r\n <<a title=\"An identifier or a link to a resource that identifies a device used in administering the medication to the patient.\" class=\"dict\" href=\"medicationstatement-definitions.html#MedicationStatement.device\"><b>device</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"device.html#Device\">Device</a>)</span> <span style=\"color: navy\">E.g. infusion pump</span><span style=\"color: Gray\"> --></span></device>\r\n <<a title=\"Indicates how the medication is/was used by the patient.\" class=\"dict\" href=\"medicationstatement-definitions.html#MedicationStatement.dosage\"><b>dosage</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Details of how medication was taken --></span>\r\n <<a title=\"The timing schedule for giving the medication to the patient. The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".\" class=\"dict\" href=\"medicationstatement-definitions.html#MedicationStatement.dosage.timing\"><b>timing</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Schedule\">Schedule</a></span> <span style=\"color: navy\">When/how often was medication taken?</span><span style=\"color: Gray\"> --></span></timing>\r\n <<a title=\"If set to true or if specified as a CodeableConcept, indicates that the medication is only taken when needed within the specified schedule rather than at every scheduled dose. If a CodeableConcept is present, it indicates the pre-condition for taking the Medication.\" class=\"dict\" href=\"medicationstatement-definitions.html#MedicationStatement.dosage.asNeeded_x_\"><b>asNeeded[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a>|<a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Take "as needed" f(or x)</span><span style=\"color: Gray\"> --></span></asNeeded[x]>\r\n <<a title=\"A coded specification of the anatomic site where the medication first enters the body.\" class=\"dict\" href=\"medicationstatement-definitions.html#MedicationStatement.dosage.site\"><b>site</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-approach-site-codes.html\">Where on body was medication administered?</a></span><span style=\"color: Gray\"> --></span></site>\r\n <<a title=\"A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject.\" class=\"dict\" href=\"medicationstatement-definitions.html#MedicationStatement.dosage.route\"><b>route</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-route-codes.html\">How did the medication enter the body?</a></span><span style=\"color: Gray\"> --></span></route>\r\n <<a title=\"A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. Examples: Slow Push; Deep IV.\n\nTerminologies used often pre-coordinate this term with the route and or form of administration.\" class=\"dict\" href=\"medicationstatement-definitions.html#MedicationStatement.dosage.method\"><b>method</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administration-method-codes.html\">Technique used to administer medication</a></span><span style=\"color: Gray\"> --></span></method>\r\n <<a title=\"The amount of therapeutic or other substance given at one administration event.\" class=\"dict\" href=\"medicationstatement-definitions.html#MedicationStatement.dosage.quantity\"><b>quantity</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">Amount administered in one dose</span><span style=\"color: Gray\"> --></span></quantity>\r\n <<a title=\"Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours.\" class=\"dict\" href=\"medicationstatement-definitions.html#MedicationStatement.dosage.rate\"><b>rate</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Ratio\">Ratio</a></span> <span style=\"color: navy\">Dose quantity per unit of time</span><span style=\"color: Gray\"> --></span></rate>\r\n <<a title=\"The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. E.g. 1000mg in 24 hours.\" class=\"dict\" href=\"medicationstatement-definitions.html#MedicationStatement.dosage.maxDosePerPeriod\"><b>maxDosePerPeriod</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Ratio\">Ratio</a></span> <span style=\"color: navy\">\r\n Maximum dose that was consumed per unit of time</span><span style=\"color: Gray\"> --></span></maxDosePerPeriod>\r\n </dosage>\r\n</MedicationStatement>\r\n</pre></div>"
},
"name": "medicationstatement",
"publisher": "FHIR Project",
"description": "Basic Profile. A record of medication being taken by a patient, or that the medication has been given to a patient where the record is the result of a report from the patient or another clinician.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage Common usage includes: \r\n\r\n* the recording of non-prescription and/or recreational drugs\r\n* the recording of an intake medication list upon admission to hospital\r\n* the summarization of a patient's \"active medications\" in a patient profile",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "MedicationStatement",
"publish": true,
"element": [
{
"path": "MedicationStatement",
"definition": {
"short": "Administration of medication to a patient",
"formal": "A record of medication being taken by a patient, or that the medication has been given to a patient where the record is the result of a report from the patient or another clinician.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"constraint": [
{
"key": "1",
"name": "Not given reason",
"severity": "error",
"human": "Reason not given is only permitted if wasNotGiven is true",
"xpath": "not(exists(f:reasonNotGiven)) or f:wasNotGiven='true'"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "SubstanceAdministration"
}
]
}
},
{
"path": "MedicationStatement.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MedicationStatement.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MedicationStatement.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "MedicationStatement.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "MedicationStatement.identifier",
"definition": {
"short": "External Identifier",
"formal": "External identifier - FHIR will generate its own internal IDs (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "SubstanceAdministration.id"
},
{
"identity": "v2",
"map": "RXA-25-Administered Barcode Identifier?"
}
]
}
},
{
"path": "MedicationStatement.patient",
"definition": {
"short": "Who was/is taking medication",
"formal": "The person or animal who is /was taking the medication.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "SubstanceAdministration->subject->Patient"
},
{
"identity": "v2",
"map": "PID-3-Patient ID List"
}
]
}
},
{
"path": "MedicationStatement.wasNotGiven",
"definition": {
"short": "True if medication is/was not being taken",
"formal": "Set this to true if the record is saying that the medication was NOT taken.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "SubstanceAdministration.actionNegationInd"
},
{
"identity": "v2",
"map": "RXA-20-Completion Status='NA'"
}
]
}
},
{
"path": "MedicationStatement.reasonNotGiven",
"definition": {
"short": "True if asserting medication was not given",
"formal": "A code indicating why the medication was not taken.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "MedicationAdministrationNegationReason",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/reason-medication-not-given-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": "SubstanceAdministration->Reason->Observation->Value"
},
{
"identity": "v2",
"map": "RXA-9-Administration Notes:RXA-20-Completion Status='NA'"
}
]
}
},
{
"path": "MedicationStatement.whenGiven",
"definition": {
"short": "Over what period was medication consumed?",
"formal": "The interval of time during which it is being asserted that the patient was taking the medication.",
"comments": "If the medication is still being taken at the time the statement is recorded, the \"end\" date will be omitted.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "SubstanceAdministration.effectiveTime"
},
{
"identity": "v2",
"map": "RXA-3-Date/Time Start of Administration / RXA-4-Date/Time End of Administration"
}
]
}
},
{
"path": "MedicationStatement.medication",
"definition": {
"short": "What medication was taken?",
"formal": "Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.",
"comments": "Note: do not use Medication.name to describe the medication this statement concerns. When the only available information is a text description of the medication, Medication.code.text should be used.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Medication"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "SubstanceAdministration>Component>SubstanceAdministrationRequest.consumable"
},
{
"identity": "v2",
"map": "RXA-5-Administered Code"
}
]
}
},
{
"path": "MedicationStatement.device",
"definition": {
"short": "E.g. infusion pump",
"formal": "An identifier or a link to a resource that identifies a device used in administering the medication to the patient.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "SubstanceAdministration->device->Access OR SubstanceAdministration->device->AssignedDevice"
},
{
"identity": "v2",
"map": "PRT-10-Participation Device"
}
]
}
},
{
"path": "MedicationStatement.dosage",
"definition": {
"short": "Details of how medication was taken",
"formal": "Indicates how the medication is/was used by the patient.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "SubstanceAdministration>Component>SubstanceAdministrationRequest"
}
]
}
},
{
"path": "MedicationStatement.dosage.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MedicationStatement.dosage.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MedicationStatement.dosage.timing",
"definition": {
"short": "When/how often was medication taken?",
"formal": "The timing schedule for giving the medication to the patient. The Schedule data type allows many different expressions, for example. \"Every 8 hours\"; \"Three times a day\"; \"1/2 an hour before breakfast for 10 days from 23-Dec 2011:\"; \"15 Oct 2013, 17 Oct 2013 and 1 Nov 2013\".",
"min": 0,
"max": "1",
"type": [
{
"code": "Schedule"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "v2",
"map": "RAS:TQ1"
}
]
}
},
{
"path": "MedicationStatement.dosage.asNeeded[x]",
"definition": {
"short": "Take \"as needed\" f(or x)",
"formal": "If set to true or if specified as a CodeableConcept, indicates that the medication is only taken when needed within the specified schedule rather than at every scheduled dose. If a CodeableConcept is present, it indicates the pre-condition for taking the Medication.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
},
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "MedicationAsNeededReason",
"isExtensible": true,
"conformance": "preferred",
"description": "A coded concept identifying the pre-condition that should hold prior to consuming a medication dose. For example \"pain\", \"30 minutes prior to sexual intercourse\", \"on flare-up\", etc."
},
"mapping": [
{
"identity": "rim",
"map": "boolean: .outboundRelationship[typeCode=PRCN].negationInd (inversed - so negationInd = true means asNeeded=false\n\nCodeableConcept: .outboundRelationship[typCode=PRCN].target[classCode=OBS, moodCode=EVN, isCriterionInd=true, code=\"Assertion\"].value"
}
]
}
},
{
"path": "MedicationStatement.dosage.site",
"definition": {
"short": "Where on body was medication administered?",
"formal": "A coded specification of the anatomic site where the medication first enters the body.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "MedicationAdministrationSite",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/approach-site-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": ".approachSiteCode"
},
{
"identity": "v2",
"map": "RXR-2-Administration Site"
}
]
}
},
{
"path": "MedicationStatement.dosage.route",
"definition": {
"short": "How did the medication enter the body?",
"formal": "A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "RouteOfAdministration",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/route-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": ".routeCode"
},
{
"identity": "v2",
"map": "RXR-1-Route"
}
]
}
},
{
"path": "MedicationStatement.dosage.method",
"definition": {
"short": "Technique used to administer medication",
"formal": "A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. Examples: Slow Push; Deep IV.\n\nTerminologies used often pre-coordinate this term with the route and or form of administration.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "MedicationAdministrationMethod",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/administration-method-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": ".methodCode"
},
{
"identity": "v2",
"map": "RXR-4-Administration Method"
}
]
}
},
{
"path": "MedicationStatement.dosage.quantity",
"definition": {
"short": "Amount administered in one dose",
"formal": "The amount of therapeutic or other substance given at one administration event.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".doseQuantity"
},
{
"identity": "v2",
"map": "RXA-6-Administered Amount / RXA-7.1-Administered Units.code / RXA-7.3-Administered Units.name of coding system"
}
]
}
},
{
"path": "MedicationStatement.dosage.rate",
"definition": {
"short": "Dose quantity per unit of time",
"formal": "Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".rateQuantity"
},
{
"identity": "v2",
"map": "RXA-12-Administered Per (Time Unit)"
}
]
}
},
{
"path": "MedicationStatement.dosage.maxDosePerPeriod",
"definition": {
"short": "Maximum dose that was consumed per unit of time",
"formal": "The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. E.g. 1000mg in 24 hours.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".maxDoseQuantity"
},
{
"identity": "v2",
"map": "RXE-4-Give Amount - Maximum / RXE-5-Give Units"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "device",
"type": "reference",
"documentation": "Return administrations with this administration device identity",
"xpath": "f:MedicationStatement/f:device"
},
{
"name": "identifier",
"type": "token",
"documentation": "Return administrations with this external identity",
"xpath": "f:MedicationStatement/f:identifier"
},
{
"name": "medication",
"type": "reference",
"documentation": "Code for medicine or text in medicine name",
"xpath": "f:MedicationStatement/f:medication"
},
{
"name": "patient",
"type": "reference",
"documentation": "The identity of a patient to list administrations for",
"xpath": "f:MedicationStatement/f:patient"
},
{
"name": "when-given",
"type": "date",
"documentation": "Date of administration",
"xpath": "f:MedicationStatement/f:whenGiven"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"A record of medication being taken by a patient, or that the medication has been given to a patient where the record is the result of a report from the patient or another clinician.\" class=\"dict\" href=\"medicationstatement-definitions.html#MedicationStatement\"><b>MedicationStatement</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"External identifier - FHIR will generate its own internal IDs (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationstatement-definitions.html#MedicationStatement.identifier\"><span style=\"text-decoration: underline\"><b>identifier</b></span></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">External Identifier</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"The person or animal who is /was taking the medication.\" class=\"dict\" href=\"medicationstatement-definitions.html#MedicationStatement.patient\"><b>patient</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Who was/is taking medication</span><span style=\"color: Gray\"> --></span></patient>\r\n <<a title=\"Set this to true if the record is saying that the medication was NOT taken.\" class=\"dict\" href=\"medicationstatement-definitions.html#MedicationStatement.wasNotGiven\"><b>wasNotGiven</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">True if medication is/was not being taken</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A code indicating why the medication was not taken.\" class=\"dict\" href=\"medicationstatement-definitions.html#MedicationStatement.reasonNotGiven\"><b>reasonNotGiven</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: Reason not given is only permitted if wasNotGiven is true\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-reason-medication-not-given-codes.html\">True if asserting medication was not given</a></span><span style=\"color: Gray\"> --></span></reasonNotGiven>\r\n <<a title=\"The interval of time during which it is being asserted that the patient was taking the medication.\" class=\"dict\" href=\"medicationstatement-definitions.html#MedicationStatement.whenGiven\"><b>whenGiven</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">Over what period was medication consumed?</span><span style=\"color: Gray\"> --></span></whenGiven>\r\n <<a title=\"Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.\" class=\"dict\" href=\"medicationstatement-definitions.html#MedicationStatement.medication\"><b>medication</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"medication.html#Medication\">Medication</a>)</span> <span style=\"color: navy\">What medication was taken?</span><span style=\"color: Gray\"> --></span></medication>\r\n <<a title=\"An identifier or a link to a resource that identifies a device used in administering the medication to the patient.\" class=\"dict\" href=\"medicationstatement-definitions.html#MedicationStatement.device\"><b>device</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"device.html#Device\">Device</a>)</span> <span style=\"color: navy\">E.g. infusion pump</span><span style=\"color: Gray\"> --></span></device>\r\n <<a title=\"Indicates how the medication is/was used by the patient.\" class=\"dict\" href=\"medicationstatement-definitions.html#MedicationStatement.dosage\"><b>dosage</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Details of how medication was taken --></span>\r\n <<a title=\"The timing schedule for giving the medication to the patient. The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".\" class=\"dict\" href=\"medicationstatement-definitions.html#MedicationStatement.dosage.timing\"><b>timing</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Schedule\">Schedule</a></span> <span style=\"color: navy\">When/how often was medication taken?</span><span style=\"color: Gray\"> --></span></timing>\r\n <<a title=\"If set to true or if specified as a CodeableConcept, indicates that the medication is only taken when needed within the specified schedule rather than at every scheduled dose. If a CodeableConcept is present, it indicates the pre-condition for taking the Medication.\" class=\"dict\" href=\"medicationstatement-definitions.html#MedicationStatement.dosage.asNeeded_x_\"><b>asNeeded[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a>|<a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Take "as needed" f(or x)</span><span style=\"color: Gray\"> --></span></asNeeded[x]>\r\n <<a title=\"A coded specification of the anatomic site where the medication first enters the body.\" class=\"dict\" href=\"medicationstatement-definitions.html#MedicationStatement.dosage.site\"><b>site</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-approach-site-codes.html\">Where on body was medication administered?</a></span><span style=\"color: Gray\"> --></span></site>\r\n <<a title=\"A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject.\" class=\"dict\" href=\"medicationstatement-definitions.html#MedicationStatement.dosage.route\"><b>route</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-route-codes.html\">How did the medication enter the body?</a></span><span style=\"color: Gray\"> --></span></route>\r\n <<a title=\"A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. Examples: Slow Push; Deep IV.\n\nTerminologies used often pre-coordinate this term with the route and or form of administration.\" class=\"dict\" href=\"medicationstatement-definitions.html#MedicationStatement.dosage.method\"><b>method</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administration-method-codes.html\">Technique used to administer medication</a></span><span style=\"color: Gray\"> --></span></method>\r\n <<a title=\"The amount of therapeutic or other substance given at one administration event.\" class=\"dict\" href=\"medicationstatement-definitions.html#MedicationStatement.dosage.quantity\"><b>quantity</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">Amount administered in one dose</span><span style=\"color: Gray\"> --></span></quantity>\r\n <<a title=\"Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours.\" class=\"dict\" href=\"medicationstatement-definitions.html#MedicationStatement.dosage.rate\"><b>rate</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Ratio\">Ratio</a></span> <span style=\"color: navy\">Dose quantity per unit of time</span><span style=\"color: Gray\"> --></span></rate>\r\n <<a title=\"The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. E.g. 1000mg in 24 hours.\" class=\"dict\" href=\"medicationstatement-definitions.html#MedicationStatement.dosage.maxDosePerPeriod\"><b>maxDosePerPeriod</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Ratio\">Ratio</a></span> <span style=\"color: navy\">\r\n Maximum dose that was consumed per unit of time</span><span style=\"color: Gray\"> --></span></maxDosePerPeriod>\r\n </dosage>\r\n</MedicationStatement>\r\n</pre></div>"
},
{
"title": "\"messageheader\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/messageheader",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/messageheader.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"The header for a message exchange that is either requesting or responding to an action. The resource(s) that are the subject of the action as well as other Information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader\"><b>MessageHeader</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"The identifier of this message.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.identifier\"><b>identifier</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#id\">id</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Id of this message</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The time that the message was sent.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.timestamp\"><b>timestamp</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#instant\">instant</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Time that the message was sent</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Code that identifies the event this message represents and connects it with it's definition. Events defined as part of the FHIR specification have the system value "http://hl7.org/fhir/message-type" (this element modifies the meaning of other elements)\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.event\"><span style=\"text-decoration: underline\"><b>event</b></span></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Coding\">Coding</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"message-events.html\">Code for the event this message represents</a></span><span style=\"color: Gray\"> --></span></event>\r\n <<a title=\"Information about the message that this message is a response to. Only present if this message is a response (this element modifies the meaning of other elements)\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.response\"><span style=\"text-decoration: underline\"><b>response</b></span></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> If this is a reply to prior message --></span>\r\n <<a title=\"The id of the message that this message is a response to.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.response.identifier\"><b>identifier</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#id\">id</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Id of original message</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not (this element modifies the meaning of other elements)\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.response.code\"><span style=\"text-decoration: underline\"><b>code</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"response-code.html\">ok | transient-error | fatal-error</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Full details of any issues found in the message.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.response.details\"><b>details</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"operationoutcome.html#OperationOutcome\">OperationOutcome</a>)</span> <span style=\"color: navy\">Specific list of hints/warnings/errors</span><span style=\"color: Gray\"> --></span></details>\r\n </response>\r\n <<a title=\"The source application from which this message originated.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.source\"><b>source</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..1</b></span> Message Source Application --></span>\r\n <<a title=\"Human-readable name for the target system.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.source.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Name of system</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"May include configuration or other information useful in debugging.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.source.software\"><b>software</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Name of software running the system</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Can convey versions of multiple systems in situations where a message passes through multiple hands.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.source.version\"><b>version</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Version of software running</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"An e-mail, phone, website or other contact point to use to resolve issues with message communications.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.source.contact\"><b>contact</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">Human contact for problems</span><span style=\"color: Gray\"> --></span></contact>\r\n <<a title=\"Identifies the routing target to send acknowledgements to.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.source.endpoint\"><b>endpoint</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Actual message source address or id</span><span style=\"color: Gray\"> --></span>\r\n </source>\r\n <<a title=\"The destination application which the message is intended for.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.destination\"><b>destination</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Message Destination Application(s) --></span>\r\n <<a title=\"Human-readable name for the source system.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.destination.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Name of system</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identifies the target end system in situations where the initial message transmission is to an intermediary system.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.destination.target\"><b>target</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"device.html#Device\">Device</a>)</span> <span style=\"color: navy\">Particular delivery destination within the destination</span><span style=\"color: Gray\"> --></span></target>\r\n <<a title=\"Indicates where the message should be routed to.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.destination.endpoint\"><b>endpoint</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Actual destination address or id</span><span style=\"color: Gray\"> --></span>\r\n </destination>\r\n <<a title=\"The person or device that performed the data entry leading to this message. Where there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.enterer\"><b>enterer</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">The source of the data entry</span><span style=\"color: Gray\"> --></span></enterer>\r\n <<a title=\"The logical author of the message - the person or device that decided the described event should happen. Where there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.author\"><b>author</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">The source of the decision</span><span style=\"color: Gray\"> --></span></author>\r\n <<a title=\"Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.receiver\"><b>receiver</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">\r\n Intended "real-world" recipient for the data</span><span style=\"color: Gray\"> --></span></receiver>\r\n <<a title=\"The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.responsible\"><b>responsible</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">\r\n Final responsibility for event</span><span style=\"color: Gray\"> --></span></responsible>\r\n <<a title=\"Coded indication of the cause for the event - indicates a reason for the occurance of the event that is a focus of this message.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.reason\"><b>reason</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-message-reason-encounter.html\">Cause of event</a></span><span style=\"color: Gray\"> --></span></reason>\r\n <<a title=\"The actual data of the message - a reference to the root/focus class of the event.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.data\"><b>data</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">The actual content of the message</span><span style=\"color: Gray\"> --></span></data>\r\n</MessageHeader>\r\n</pre></div>"
},
"name": "messageheader",
"publisher": "FHIR Project",
"description": "Basic Profile. The header for a message exchange that is either requesting or responding to an action. The resource(s) that are the subject of the action as well as other Information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage The MessageHeader resource is defined in order to support Messaging using FHIR resources. The principle usage of the MessageHeader resource is when messages are exchanged. However, as a resource that can be used with the RESTful framework, the MessageHeader resource has the normal resource end-point ([base-url]/Message), which is used to manage a set of static messages resources. This could be used to make an archive of past messages available. Creating or updating Message resources in this fashion does not represent the actual occurrence of any event, nor can it trigger any logic associated with the actual event. It is just for managing a set of message resources.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "MessageHeader",
"publish": true,
"element": [
{
"path": "MessageHeader",
"definition": {
"short": "A resource that describes a message that is exchanged between systems",
"formal": "The header for a message exchange that is either requesting or responding to an action. The resource(s) that are the subject of the action as well as other Information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Message"
},
{
"identity": "v2",
"map": "MSH / MSA / ERR"
}
]
}
},
{
"path": "MessageHeader.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MessageHeader.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MessageHeader.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "MessageHeader.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "MessageHeader.identifier",
"definition": {
"short": "Id of this message",
"formal": "The identifier of this message.",
"comments": "This SHALL be unique within the scope of this stream of messages.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Message.id"
},
{
"identity": "v2",
"map": "MSH-10-message control ID"
}
]
}
},
{
"path": "MessageHeader.timestamp",
"definition": {
"short": "Time that the message was sent",
"formal": "The time that the message was sent.",
"min": 1,
"max": "1",
"type": [
{
"code": "instant"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./creationTime[isNormalDatatype()]"
},
{
"identity": "v2",
"map": "MSH-7-message date/time"
}
]
}
},
{
"path": "MessageHeader.event",
"definition": {
"short": "Code for the event this message represents",
"formal": "Code that identifies the event this message represents and connects it with it's definition. Events defined as part of the FHIR specification have the system value \"http://hl7.org/fhir/message-type\".",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isModifier": true,
"binding": {
"name": "MessageEvent",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/message-events"
}
},
"mapping": [
{
"identity": "rim",
"map": "./payload[classCode=\"CACT\" and moodCode=\"EVN\" and isNormalAct()]/code[isNormalDatatype()]/code"
},
{
"identity": "v2",
"map": "MSH-9.2-message type.trigger event"
}
]
}
},
{
"path": "MessageHeader.response",
"definition": {
"short": "If this is a reply to prior message",
"formal": "Information about the message that this message is a response to. Only present if this message is a response.",
"min": 0,
"max": "1",
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "./conveyedAcknowledgement"
},
{
"identity": "v2",
"map": "MSA"
}
]
}
},
{
"path": "MessageHeader.response.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MessageHeader.response.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MessageHeader.response.identifier",
"definition": {
"short": "Id of original message",
"formal": "The id of the message that this message is a response to.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./acknowledges.id[isNormalDatatype()]"
},
{
"identity": "v2",
"map": "MSA-2-message control ID"
}
]
}
},
{
"path": "MessageHeader.response.code",
"definition": {
"short": "ok | transient-error | fatal-error",
"formal": "Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not.",
"comments": "This is a generic response to the request message. Specific data for the response will be found in MessageHeader.data.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "ResponseType",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/response-code"
}
},
"mapping": [
{
"identity": "rim",
"map": "./typeCode[isNormalDatatype()]"
},
{
"identity": "v2",
"map": "MSA-1-acknowledgment code"
}
]
}
},
{
"path": "MessageHeader.response.details",
"definition": {
"short": "Specific list of hints/warnings/errors",
"formal": "Full details of any issues found in the message.",
"comments": "This SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/OperationOutcome"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "AcknowledgementDetail or Observation[classCode=\"ALRT\" and moodCode=\"EVN\"]"
},
{
"identity": "v2",
"map": "ERR"
}
]
}
},
{
"path": "MessageHeader.source",
"definition": {
"short": "Message Source Application",
"formal": "The source application from which this message originated.",
"min": 1,
"max": "1",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "unique(./communicationFunction[typeCode=\"SND\"])"
}
]
}
},
{
"path": "MessageHeader.source.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MessageHeader.source.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MessageHeader.source.name",
"definition": {
"short": "Name of system",
"formal": "Human-readable name for the target system.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "unique(./entity[determinerCode=\"INST\" and classCode=\"DEV\"]/name[type='ST' and isNormalDatatype()])"
},
{
"identity": "v2",
"map": "MSH-3-sending application"
}
]
}
},
{
"path": "MessageHeader.source.software",
"definition": {
"short": "Name of software running the system",
"formal": "May include configuration or other information useful in debugging.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "unique(./entity[determinerCode=\"INST\" and classCode=\"DEV\"]/softwareName[isNormalDatatype()])"
},
{
"identity": "v2",
"map": "SFT-3-software product name ( +SFT-1-software vendor organization)"
}
]
}
},
{
"path": "MessageHeader.source.version",
"definition": {
"short": "Version of software running",
"formal": "Can convey versions of multiple systems in situations where a message passes through multiple hands.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "(Not supported)"
},
{
"identity": "v2",
"map": "SFT-2-software certified version or release number"
}
]
}
},
{
"path": "MessageHeader.source.contact",
"definition": {
"short": "Human contact for problems",
"formal": "An e-mail, phone, website or other contact point to use to resolve issues with message communications.",
"min": 0,
"max": "1",
"type": [
{
"code": "Contact"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "unique(./entity[determinerCode=\"INST\" and classCode=\"DEV\"]/scopesRole[normalRole() and classCode=\"CON\" and layer[classCode=\"PSN\"]/telecom[isNormalDatatype()])"
},
{
"identity": "v2",
"map": "(MSH-22?)"
}
]
}
},
{
"path": "MessageHeader.source.endpoint",
"definition": {
"short": "Actual message source address or id",
"formal": "Identifies the routing target to send acknowledgements to.",
"comments": "The id may be a non-resolvable URI for systems that do not use standard network-based addresses.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./telecom[isNormalDatatype()]"
},
{
"identity": "v2",
"map": "MSH-24-sending network address"
}
]
}
},
{
"path": "MessageHeader.destination",
"definition": {
"short": "Message Destination Application(s)",
"formal": "The destination application which the message is intended for.",
"comments": "there SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./communicationFunction[typeCode=\"RCV\"]"
}
]
}
},
{
"path": "MessageHeader.destination.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MessageHeader.destination.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MessageHeader.destination.name",
"definition": {
"short": "Name of system",
"formal": "Human-readable name for the source system.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "unique(./entity[determinerCode=\"INST\" and (classCode=(\"DEV\", \"PSN\", \"ORG\"]/name[type='ST' and isNormalDatatype()])"
},
{
"identity": "v2",
"map": "MSH-5-receiving application"
}
]
}
},
{
"path": "MessageHeader.destination.target",
"definition": {
"short": "Particular delivery destination within the destination",
"formal": "Identifies the target end system in situations where the initial message transmission is to an intermediary system.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "unique(./entity[determinerCode=\"INST\" and (classCode=(\"DEV\", \"PSN\", \"ORG\"]"
}
]
}
},
{
"path": "MessageHeader.destination.endpoint",
"definition": {
"short": "Actual destination address or id",
"formal": "Indicates where the message should be routed to.",
"comments": "The id may be a non-resolvable URI for systems that do not use standard network-based addresses.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./telecom"
},
{
"identity": "v2",
"map": "MSH-25-receiving network address (or MSH-6-receiving facility by implication)"
}
]
}
},
{
"path": "MessageHeader.enterer",
"definition": {
"short": "The source of the data entry",
"formal": "The person or device that performed the data entry leading to this message. Where there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions.",
"comments": "Usually only for the request, but can be used in a response.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[typeCode=\"ENT\" and isNormalParticipation]/role[classCode=\"ASSIGNED\" and isNormalRole()]/player[isNormalEntity() and classCode=(\"DEV\", \"PSN\") and determinerCode=\"INST\"])"
},
{
"identity": "v2",
"map": "EVN-5-operator ID / ORC-10-entered by / PRT-5-Participation Person:PRT-4-Participation='EP' / ROL where ROL.3 is EP or ORC.10"
}
]
}
},
{
"path": "MessageHeader.author",
"definition": {
"short": "The source of the decision",
"formal": "The logical author of the message - the person or device that decided the described event should happen. Where there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions.",
"comments": "Usually only for the request, but can be used in a response.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode=\"AUT\" and isNormalParticipation]/role[classCode=\"ASSIGNED\" and isNormalRole()]/player[isNormalEntity() and classCode=(\"DEV\", \"PSN\") and determinerCode=\"INST\"])"
},
{
"identity": "v2",
"map": "ORC-19-action by / PRT-5-Participation Person:PRT-4-Participation='AUT' / ROL where ROL.3 is IP or ORC.12"
}
]
}
},
{
"path": "MessageHeader.receiver",
"definition": {
"short": "Intended \"real-world\" recipient for the data",
"formal": "Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText"
},
{
"identity": "v2",
"map": "PRT-5-Participation Person:PRT-4-Participation='WAYR' / PRT-8-Participation Organization:PRT-4-Participation='WAYR'"
}
]
}
},
{
"path": "MessageHeader.responsible",
"definition": {
"short": "Final responsibility for event",
"formal": "The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party.",
"comments": "Usually only for the request, but can be used in a response.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode=\"RESP\" and isNormalParticipation]/role[classCode=\"ASSIGNED\" and isNormalRole()]/player[isNormalEntity() and classCode=\"PSN\" and determinerCode=\"INST\"] or ./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode=\"RESP\" and isNormalParticipation]/role[classCode=\"ASSIGNED\" and isNormalRole()]/scoper[isNormalEntity() and classCode=\"ORG\" and determinerCode=\"INST\"])"
},
{
"identity": "v2",
"map": "ORC-12-ordering provider / \nPRT-5-Participation Person:PRT-4-Participation='OP' / \nPRT-8-Participation Organization:PRT-4-Participation='OP'\n/ ROL where ROL.3 is RO or ORC.11"
}
]
}
},
{
"path": "MessageHeader.reason",
"definition": {
"short": "Cause of event",
"formal": "Coded indication of the cause for the event - indicates a reason for the occurance of the event that is a focus of this message.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "EventReason",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/message-reason-encounter"
}
},
"mapping": [
{
"identity": "rim",
"map": "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/reasonCode[isNormalDatatype()])"
},
{
"identity": "v2",
"map": "EVN.4 / ORC.16 / OBR-31-reason for study / BPO-13-BP indication for use / RXO-20-indication / RXE-27-give indication / RXD-21-indication / RXG-22-indication / RXA-19-indication"
}
]
}
},
{
"path": "MessageHeader.data",
"definition": {
"short": "The actual content of the message",
"formal": "The actual data of the message - a reference to the root/focus class of the event.",
"comments": "The data is defined where the transaction type is defined. The transaction data is always included in the bundle that is the full message. Only the root resource is specified. The resources it references should be contained in the bundle but are not also listed here. Multiple repetitions are allowed to cater for merges and other situations with multiple focal targets.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Any"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[typeCode=\"SUBJ\" and isNormalParticipation]/role or ./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/outboundRelationship[typeCode=\"SBJ\" and isNormalActRelatoinship]/target)"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"The header for a message exchange that is either requesting or responding to an action. The resource(s) that are the subject of the action as well as other Information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader\"><b>MessageHeader</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"The identifier of this message.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.identifier\"><b>identifier</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#id\">id</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Id of this message</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The time that the message was sent.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.timestamp\"><b>timestamp</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#instant\">instant</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Time that the message was sent</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Code that identifies the event this message represents and connects it with it's definition. Events defined as part of the FHIR specification have the system value "http://hl7.org/fhir/message-type" (this element modifies the meaning of other elements)\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.event\"><span style=\"text-decoration: underline\"><b>event</b></span></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Coding\">Coding</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"message-events.html\">Code for the event this message represents</a></span><span style=\"color: Gray\"> --></span></event>\r\n <<a title=\"Information about the message that this message is a response to. Only present if this message is a response (this element modifies the meaning of other elements)\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.response\"><span style=\"text-decoration: underline\"><b>response</b></span></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> If this is a reply to prior message --></span>\r\n <<a title=\"The id of the message that this message is a response to.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.response.identifier\"><b>identifier</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#id\">id</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Id of original message</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not (this element modifies the meaning of other elements)\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.response.code\"><span style=\"text-decoration: underline\"><b>code</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"response-code.html\">ok | transient-error | fatal-error</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Full details of any issues found in the message.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.response.details\"><b>details</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"operationoutcome.html#OperationOutcome\">OperationOutcome</a>)</span> <span style=\"color: navy\">Specific list of hints/warnings/errors</span><span style=\"color: Gray\"> --></span></details>\r\n </response>\r\n <<a title=\"The source application from which this message originated.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.source\"><b>source</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..1</b></span> Message Source Application --></span>\r\n <<a title=\"Human-readable name for the target system.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.source.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Name of system</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"May include configuration or other information useful in debugging.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.source.software\"><b>software</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Name of software running the system</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Can convey versions of multiple systems in situations where a message passes through multiple hands.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.source.version\"><b>version</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Version of software running</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"An e-mail, phone, website or other contact point to use to resolve issues with message communications.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.source.contact\"><b>contact</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">Human contact for problems</span><span style=\"color: Gray\"> --></span></contact>\r\n <<a title=\"Identifies the routing target to send acknowledgements to.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.source.endpoint\"><b>endpoint</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Actual message source address or id</span><span style=\"color: Gray\"> --></span>\r\n </source>\r\n <<a title=\"The destination application which the message is intended for.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.destination\"><b>destination</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Message Destination Application(s) --></span>\r\n <<a title=\"Human-readable name for the source system.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.destination.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Name of system</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identifies the target end system in situations where the initial message transmission is to an intermediary system.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.destination.target\"><b>target</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"device.html#Device\">Device</a>)</span> <span style=\"color: navy\">Particular delivery destination within the destination</span><span style=\"color: Gray\"> --></span></target>\r\n <<a title=\"Indicates where the message should be routed to.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.destination.endpoint\"><b>endpoint</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Actual destination address or id</span><span style=\"color: Gray\"> --></span>\r\n </destination>\r\n <<a title=\"The person or device that performed the data entry leading to this message. Where there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.enterer\"><b>enterer</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">The source of the data entry</span><span style=\"color: Gray\"> --></span></enterer>\r\n <<a title=\"The logical author of the message - the person or device that decided the described event should happen. Where there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.author\"><b>author</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">The source of the decision</span><span style=\"color: Gray\"> --></span></author>\r\n <<a title=\"Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.receiver\"><b>receiver</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">\r\n Intended "real-world" recipient for the data</span><span style=\"color: Gray\"> --></span></receiver>\r\n <<a title=\"The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.responsible\"><b>responsible</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">\r\n Final responsibility for event</span><span style=\"color: Gray\"> --></span></responsible>\r\n <<a title=\"Coded indication of the cause for the event - indicates a reason for the occurance of the event that is a focus of this message.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.reason\"><b>reason</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-message-reason-encounter.html\">Cause of event</a></span><span style=\"color: Gray\"> --></span></reason>\r\n <<a title=\"The actual data of the message - a reference to the root/focus class of the event.\" class=\"dict\" href=\"messageheader-definitions.html#MessageHeader.data\"><b>data</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">The actual content of the message</span><span style=\"color: Gray\"> --></span></data>\r\n</MessageHeader>\r\n</pre></div>"
},
{
"title": "\"observation\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/observation",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/observation.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"Measurements and simple assertions made about a patient, device or other subject.\" class=\"dict\" href=\"observation-definitions.html#Observation\"><b>Observation</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Describes what was observed. Sometimes this is called the observation "code".\" class=\"dict\" href=\"observation-definitions.html#Observation.name\"><b>name</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-observation-codes.html\">Type of observation (code / type)</a></span><span style=\"color: Gray\"> --></span></name>\r\n <<a title=\"The information determined as a result of making the observation, if the information has a simple value.\" class=\"dict\" href=\"observation-definitions.html#Observation.value_x_\"><b>value[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a>|<a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a>|<a href=\"datatypes.html#Attachment\">Attachment</a>|<a href=\"datatypes.html#Ratio\">Ratio</a>|<a href=\"datatypes.html#Period\">Period</a>|\r\n <a href=\"datatypes.html#SampledData\">SampledData</a>|<a href=\"datatypes.html#string\">string</a></span> <span style=\"color: navy\">Actual result</span><span style=\"color: Gray\"> --></span></value[x]>\r\n <<a title=\"The assessment made based on the result of the observation.\" class=\"dict\" href=\"observation-definitions.html#Observation.interpretation\"><b>interpretation</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-observation-interpretation.html\">High, low, normal, etc.</a></span><span style=\"color: Gray\"> --></span></interpretation>\r\n <<a title=\"May include statements about significant, unexpected or unreliable values, or information about the source of the value where this may be relevant to the interpretation of the result.\" class=\"dict\" href=\"observation-definitions.html#Observation.comments\"><b>comments</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Comments about result</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.\" class=\"dict\" href=\"observation-definitions.html#Observation.applies_x_\"><b>applies[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a>|<a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">\r\n Physiologically Relevant time/time-period for observation</span><span style=\"color: Gray\"> --></span></applies[x]>\r\n <<a title=\"Date/Time this was made available.\" class=\"dict\" href=\"observation-definitions.html#Observation.issued\"><b>issued</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#instant\">instant</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Date/Time this was made available</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The status of the result value (this element modifies the meaning of other elements)\" class=\"dict\" href=\"observation-definitions.html#Observation.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"observation-status.html\">registered | preliminary | final | amended +</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"An estimate of the degree to which quality issues have impacted on the value reported (this element modifies the meaning of other elements)\" class=\"dict\" href=\"observation-definitions.html#Observation.reliability\"><span style=\"text-decoration: underline\"><b>reliability</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"observation-reliability.html\">ok | ongoing | early | questionable | calibrating | error +</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Indicates where on the subject's body the observation was made.\" class=\"dict\" href=\"observation-definitions.html#Observation.bodySite\"><b>bodySite</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-body-site.html\">Observed body part</a></span><span style=\"color: Gray\"> --></span></bodySite>\r\n <<a title=\"Indicates the mechanism used to perform the observation.\" class=\"dict\" href=\"observation-definitions.html#Observation.method\"><b>method</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-observation-methods.html\">How it was done</a></span><span style=\"color: Gray\"> --></span></method>\r\n <<a title=\"A unique identifier for the simple observation.\" class=\"dict\" href=\"observation-definitions.html#Observation.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Unique Id for this particular observation</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"The thing the observation is being made about.\" class=\"dict\" href=\"observation-definitions.html#Observation.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"group.html#Group\">Group</a>|<a href=\"device.html#Device\">Device</a>|<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">Who and/or what this is about</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"The specimen that was used when this observation was made.\" class=\"dict\" href=\"observation-definitions.html#Observation.specimen\"><b>specimen</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"specimen.html#Specimen\">Specimen</a>)</span> <span style=\"color: navy\">Specimen used for this observation</span><span style=\"color: Gray\"> --></span></specimen>\r\n <<a title=\"Who was responsible for asserting the observed value as "true".\" class=\"dict\" href=\"observation-definitions.html#Observation.performer\"><b>performer</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"device.html#Device\">Device</a>|<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">Who did the observation</span><span style=\"color: Gray\"> --></span></performer>\r\n <<a title=\"Guidance on how to interpret the value by comparison to a normal or recommended range.\" class=\"dict\" href=\"observation-definitions.html#Observation.referenceRange\"><b>referenceRange</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Provides guide for interpretation --></span>\r\n <<a title=\"The value of the low bound of the reference range. If this is omitted, the low bound of the reference range is assumed to be meaningless. E.g. <2.3.\" class=\"dict\" href=\"observation-definitions.html#Observation.referenceRange.low\"><b>low</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-3: Must have at least a low or a high (and no comparators)\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">Low Range, if relevant</span><span style=\"color: Gray\"> --></span></low>\r\n <<a title=\"The value of the high bound of the reference range. If this is omitted, the high bound of the reference range is assumed to be meaningless. E.g. >5.\" class=\"dict\" href=\"observation-definitions.html#Observation.referenceRange.high\"><b>high</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-3: Must have at least a low or a high (and no comparators)\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">High Range, if relevant</span><span style=\"color: Gray\"> --></span></high>\r\n <<a title=\"Code for the meaning of the reference range.\" class=\"dict\" href=\"observation-definitions.html#Observation.referenceRange.meaning\"><b>meaning</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-referencerange-meaning.html\">Indicates the meaning/use of this range of this range</a></span><span style=\"color: Gray\"> --></span></meaning>\r\n <<a title=\"The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.\" class=\"dict\" href=\"observation-definitions.html#Observation.referenceRange.age\"><b>age</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Range\">Range</a></span> <span style=\"color: navy\">Applicable age range, if relevant</span><span style=\"color: Gray\"> --></span></age>\r\n </referenceRange>\r\n <<a title=\"Related observations - either components, or previous observations, or statements of derivation.\" class=\"dict\" href=\"observation-definitions.html#Observation.related\"><b>related</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Observations related to this observation --></span>\r\n <<a title=\"A code specifying the kind of relationship that exists with the target observation.\" class=\"dict\" href=\"observation-definitions.html#Observation.related.type\"><b>type</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"observation-relationshiptypes.html\">has-component | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A reference to the observation that is related to this observation.\" class=\"dict\" href=\"observation-definitions.html#Observation.related.target\"><b>target</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"observation.html#Observation\">Observation</a>)</span> <span style=\"color: navy\">Observation that is related to this one</span><span style=\"color: Gray\"> --></span></target>\r\n </related>\r\n</Observation>\r\n</pre></div>"
},
"name": "observation",
"publisher": "FHIR Project",
"description": "Basic Profile. Measurements and simple assertions made about a patient, device or other subject.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage Observations are a central element in healthcare, used to support diagnosis, monitor progress, determine baselines and patterns and even capture demographic characteristics. Most observations are simple name/value pair assertions with some metadata, but some observations group other observations together logically, or even are multi-component observations. Note that the resources DiagnosticReport and DeviceObservationReport provide a clinical or workflow context for a set of observations. Expected uses for the Observation resource include: \r\n\r\n* Vital signs: temperature, blood pressure, respiration rate\r\n* Laboratory Data and other Diagnostic Measures\r\n* Measurements emitted by Devices\r\n* Clinical assessments such as APGAR\r\n* Personal characteristics: height, weight, eye-color\r\n* Diagnoses (Note: trackable conditions, allergies, adverse reactions and more complex structures are handled elsewhere)\r\n* Social history: tobacco use, family supports, cognitive status\r\n* Core characteristics: pregnancy status, death assertion",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "Observation",
"publish": true,
"element": [
{
"path": "Observation",
"definition": {
"short": "Measurements and simple assertions",
"formal": "Measurements and simple assertions made about a patient, device or other subject.",
"comments": "Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as Lab reports, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"constraint": [
{
"key": "2",
"name": "reference range for quantity",
"severity": "error",
"human": "Can only have normal range if value is a quantity",
"xpath": "exists(f:valueQuantity) or not(exists(f:normalRange))"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Observation[classCode=OBS, moodCode=EVN]"
},
{
"identity": "v2",
"map": "OBX"
}
]
}
},
{
"path": "Observation.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Observation.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Observation.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "Observation.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "Observation.name",
"definition": {
"short": "Type of observation (code / type)",
"formal": "Describes what was observed. Sometimes this is called the observation \"code\".",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ObservationType",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/observation-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": "code"
},
{
"identity": "v2",
"map": "OBX-3-observation identifier"
}
]
}
},
{
"path": "Observation.value[x]",
"definition": {
"short": "Actual result",
"formal": "The information determined as a result of making the observation, if the information has a simple value.",
"comments": "Normally, an observation will have either a value or a set of related observations. A few observations (e.g. apgar store) may have both a value and related observations (for apgar, the observations from which the measure is derived). If a value is present, the datatype for this element should be determined by Observation.name. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.name defines a coded value. The element, Observation.value[x], has a variable name depending on the type as follows: valueQuantity, valueCodeableConcept, valueRatio, valueChoice, valuePeriod, valueSampleData, or valueString (The name format is \"'value' + the type name\" with a capital on the first letter of the type).",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
},
{
"code": "CodeableConcept"
},
{
"code": "Attachment"
},
{
"code": "Ratio"
},
{
"code": "Period"
},
{
"code": "SampledData"
},
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "value"
},
{
"identity": "v2",
"map": "OBX.2, OBX.5, OBX.6"
}
]
}
},
{
"path": "Observation.interpretation",
"definition": {
"short": "High, low, normal, etc.",
"formal": "The assessment made based on the result of the observation.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ObservationInterpretation",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/observation-interpretation"
}
},
"mapping": [
{
"identity": "rim",
"map": "interpretationCode"
},
{
"identity": "v2",
"map": "OBX-8-interpretation codes"
}
]
}
},
{
"path": "Observation.comments",
"definition": {
"short": "Comments about result",
"formal": "May include statements about significant, unexpected or unreliable values, or information about the source of the value where this may be relevant to the interpretation of the result.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "subjectOf.observationEvent[code=\"annotation\"].value"
},
{
"identity": "v2",
"map": "NTE.3 (partner NTE to OBX, or sometimes another (child?) OBX)"
}
]
}
},
{
"path": "Observation.applies[x]",
"definition": {
"short": "Physiologically Relevant time/time-period for observation",
"formal": "The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the \"physiologically relevant time\". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.",
"comments": "At least a date should be present unless this observation is a historical report.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "effectiveTime"
},
{
"identity": "v2",
"map": "OBX-14-date/time of the observation, and/or OBX-19 after v2.4 (depends on who observation made)"
}
]
}
},
{
"path": "Observation.issued",
"definition": {
"short": "Date/Time this was made available",
"formal": "Date/Time this was made available.",
"comments": "Updated when the result is updated.",
"min": 0,
"max": "1",
"type": [
{
"code": "instant"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "participation[typeCode=AUT].time"
},
{
"identity": "v2",
"map": "OBR.22 (or MSH.7), or perhaps OBX-19 (depends on who observation made)"
}
]
}
},
{
"path": "Observation.status",
"definition": {
"short": "registered | preliminary | final | amended +",
"formal": "The status of the result value.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "ObservationStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/observation-status"
}
},
"mapping": [
{
"identity": "rim",
"map": "status\n\nAmended & Final are differentiated by whether it is the subject of a ControlAct event with a type of \"revise\""
},
{
"identity": "v2",
"map": "OBX-11-observation result status"
}
]
}
},
{
"path": "Observation.reliability",
"definition": {
"short": "ok | ongoing | early | questionable | calibrating | error +",
"formal": "An estimate of the degree to which quality issues have impacted on the value reported.",
"comments": "Note that in most contexts, unreliable results are not recorded, deleted, or otherwise excluded, but it's not always possible to exclude them from the record. Interpreters of a result, whether human or machine, SHALL always either be aware of the status, or prevented from using the observation without being unaware that the reliability is not \"ok\".",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "ObservationReliability",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/observation-reliability"
}
},
"mapping": [
{
"identity": "rim",
"map": "uncertaintyCode"
},
{
"identity": "v2",
"map": "Maybe OBX.8/OBX.9"
}
]
}
},
{
"path": "Observation.bodySite",
"definition": {
"short": "Observed body part",
"formal": "Indicates where on the subject's body the observation was made.",
"comments": "Only used if not implicit in code found in Observation.name.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "BodySite",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/body-site"
}
},
"mapping": [
{
"identity": "rim",
"map": "targetSiteCode"
},
{
"identity": "v2",
"map": "OBX-20-observation site"
}
]
}
},
{
"path": "Observation.method",
"definition": {
"short": "How it was done",
"formal": "Indicates the mechanism used to perform the observation.",
"comments": "Only used if not implicit in code for Observation.name.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ObservationMethod",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/observation-methods"
}
},
"mapping": [
{
"identity": "rim",
"map": "methodCode"
},
{
"identity": "v2",
"map": "OBX-17-observation method"
}
]
}
},
{
"path": "Observation.identifier",
"definition": {
"short": "Unique Id for this particular observation",
"formal": "A unique identifier for the simple observation.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "id"
},
{
"identity": "v2",
"map": "OBX.21"
}
]
}
},
{
"path": "Observation.subject",
"definition": {
"short": "Who and/or what this is about",
"formal": "The thing the observation is being made about.",
"comments": "The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Group"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Location"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "participation[typeCode=SBJ]"
},
{
"identity": "v2",
"map": "PID-3-patient ID list"
}
]
}
},
{
"path": "Observation.specimen",
"definition": {
"short": "Specimen used for this observation",
"formal": "The specimen that was used when this observation was made.",
"comments": "Observations are not made on specimens themselves; they are made on a subject, but usually by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources are often used in contexts that track the specimen explicity (e.g. Diagnostic Report).",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Specimen"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "participation[typeCode=SPC].specimen"
}
]
}
},
{
"path": "Observation.performer",
"definition": {
"short": "Who did the observation",
"formal": "Who was responsible for asserting the observed value as \"true\".",
"comments": "This would only be \"Device\" if the device is responsible for the measurement, not to capture the device used by a human to make the measurement. (The latter could be captured as an extension.).",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "participation[typeCode=PRF]"
},
{
"identity": "v2",
"map": "OBX.15 / (Practitioner) OBX-16-responsible observer, PRT-5-participation person:PRT-4-participation='RO' / \n(Device) OBX-18-equipment instance identifier , PRT-10-participation device:PRT-4-participation='EQUIP' / (Organization) OBX-23-performing organization name, PRT-8-participation organization:PRT-4-participation='PO'"
}
]
}
},
{
"path": "Observation.referenceRange",
"definition": {
"short": "Provides guide for interpretation",
"formal": "Guidance on how to interpret the value by comparison to a normal or recommended range.",
"comments": "Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g. specific to the patient's age, gender, weight and other factors), but this may not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "3",
"name": "reference range",
"severity": "error",
"human": "Must have at least a low or a high (and no comparators)",
"xpath": "(exists(f:low) or exists(f:high)) and not(exists(f:low/f:comparator)) and not(exists(f:high/f:comparator))"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]"
}
]
}
},
{
"path": "Observation.referenceRange.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Observation.referenceRange.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Observation.referenceRange.low",
"definition": {
"short": "Low Range, if relevant",
"formal": "The value of the low bound of the reference range. If this is omitted, the low bound of the reference range is assumed to be meaningless. E.g. <2.3.",
"comments": "Do not use the comparator for < or >.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "value:IVL_PQ.low"
},
{
"identity": "v2",
"map": "OBX-7-references range"
}
]
}
},
{
"path": "Observation.referenceRange.high",
"definition": {
"short": "High Range, if relevant",
"formal": "The value of the high bound of the reference range. If this is omitted, the high bound of the reference range is assumed to be meaningless. E.g. >5.",
"comments": "Do not use the comparator for < or >.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "value:IVL_PQ.high"
},
{
"identity": "v2",
"map": "OBX-7-references range"
}
]
}
},
{
"path": "Observation.referenceRange.meaning",
"definition": {
"short": "Indicates the meaning/use of this range of this range",
"formal": "Code for the meaning of the reference range.",
"comments": "This SHOULD be populated if there is more than one range.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ObservationRangeMeaning",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/referencerange-meaning"
}
},
"mapping": [
{
"identity": "rim",
"map": "interpretationCode"
},
{
"identity": "v2",
"map": "OBX-10-nature of abnormal test?"
}
]
}
},
{
"path": "Observation.referenceRange.age",
"definition": {
"short": "Applicable age range, if relevant",
"formal": "The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.",
"min": 0,
"max": "1",
"type": [
{
"code": "Range"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=PRCN].targetObservationCriterion[code=\"age\"].value"
}
]
}
},
{
"path": "Observation.related",
"definition": {
"short": "Observations related to this observation",
"formal": "Related observations - either components, or previous observations, or statements of derivation.",
"comments": "Normally, an observation will have either a value or a set of related observations. A few observations (e.g. apgar store) may have both a value and related observations (for apgar, the observations from which the measure is derived).",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "outBoundRelationship"
},
{
"identity": "v2",
"map": "Relationships established by OBX-4 usage"
}
]
}
},
{
"path": "Observation.related.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Observation.related.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Observation.related.type",
"definition": {
"short": "has-component | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by",
"formal": "A code specifying the kind of relationship that exists with the target observation.",
"comments": "A relationship type SHOULD be provided. If the relationship type is \"COMP\" (composed), then the observation should not be displayed/interpreted in the absence of the related observations.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "ObservationRelationshipType",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/observation-relationshiptypes"
}
},
"mapping": [
{
"identity": "rim",
"map": ".typeCode"
},
{
"identity": "v2",
"map": "N/A"
}
]
}
},
{
"path": "Observation.related.target",
"definition": {
"short": "Observation that is related to this one",
"formal": "A reference to the observation that is related to this observation.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Observation"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".targetObservation"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "date",
"type": "date",
"documentation": "Obtained date/time. If the obtained element is a period, a date that falls in the period",
"xpath": "f:Observation/f:applies[x]"
},
{
"name": "name",
"type": "token",
"documentation": "The name of the observation type",
"xpath": "f:Observation/f:name"
},
{
"name": "name-value-[x]",
"type": "composite",
"documentation": "Both name and one of the value parameters"
},
{
"name": "performer",
"type": "reference",
"documentation": "Who and/or what performed the observation",
"xpath": "f:Observation/f:performer"
},
{
"name": "related",
"type": "composite",
"documentation": "Related Observations - search on related-type and related-target together"
},
{
"name": "related-target",
"type": "reference",
"documentation": "Observation that is related to this one",
"xpath": "f:Observation/f:related/f:target"
},
{
"name": "related-type",
"type": "token",
"documentation": "has-component | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by",
"xpath": "f:Observation/f:related/f:type"
},
{
"name": "reliability",
"type": "token",
"documentation": "The reliability of the observation",
"xpath": "f:Observation/f:reliability"
},
{
"name": "specimen",
"type": "reference",
"documentation": "Specimen used for this observation",
"xpath": "f:Observation/f:specimen"
},
{
"name": "status",
"type": "token",
"documentation": "The status of the observation",
"xpath": "f:Observation/f:status"
},
{
"name": "subject",
"type": "reference",
"documentation": "The subject that the observation is about",
"xpath": "f:Observation/f:subject"
},
{
"name": "value-concept",
"type": "token",
"documentation": "The value of the observation, if the value is a CodeableConcept",
"xpath": "f:Observation/f:value[x]"
},
{
"name": "value-date",
"type": "date",
"documentation": "The value of the observation, if the value is a Period",
"xpath": "f:Observation/f:value[x]"
},
{
"name": "value-quantity",
"type": "quantity",
"documentation": "The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)",
"xpath": "f:Observation/f:value[x]"
},
{
"name": "value-string",
"type": "string",
"documentation": "The value of the observation, if the value is a string, and also searches in CodeableConcept.text",
"xpath": "f:Observation/f:value[x]"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"Measurements and simple assertions made about a patient, device or other subject.\" class=\"dict\" href=\"observation-definitions.html#Observation\"><b>Observation</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Describes what was observed. Sometimes this is called the observation "code".\" class=\"dict\" href=\"observation-definitions.html#Observation.name\"><b>name</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-observation-codes.html\">Type of observation (code / type)</a></span><span style=\"color: Gray\"> --></span></name>\r\n <<a title=\"The information determined as a result of making the observation, if the information has a simple value.\" class=\"dict\" href=\"observation-definitions.html#Observation.value_x_\"><b>value[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a>|<a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a>|<a href=\"datatypes.html#Attachment\">Attachment</a>|<a href=\"datatypes.html#Ratio\">Ratio</a>|<a href=\"datatypes.html#Period\">Period</a>|\r\n <a href=\"datatypes.html#SampledData\">SampledData</a>|<a href=\"datatypes.html#string\">string</a></span> <span style=\"color: navy\">Actual result</span><span style=\"color: Gray\"> --></span></value[x]>\r\n <<a title=\"The assessment made based on the result of the observation.\" class=\"dict\" href=\"observation-definitions.html#Observation.interpretation\"><b>interpretation</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-observation-interpretation.html\">High, low, normal, etc.</a></span><span style=\"color: Gray\"> --></span></interpretation>\r\n <<a title=\"May include statements about significant, unexpected or unreliable values, or information about the source of the value where this may be relevant to the interpretation of the result.\" class=\"dict\" href=\"observation-definitions.html#Observation.comments\"><b>comments</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Comments about result</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.\" class=\"dict\" href=\"observation-definitions.html#Observation.applies_x_\"><b>applies[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a>|<a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">\r\n Physiologically Relevant time/time-period for observation</span><span style=\"color: Gray\"> --></span></applies[x]>\r\n <<a title=\"Date/Time this was made available.\" class=\"dict\" href=\"observation-definitions.html#Observation.issued\"><b>issued</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#instant\">instant</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Date/Time this was made available</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The status of the result value (this element modifies the meaning of other elements)\" class=\"dict\" href=\"observation-definitions.html#Observation.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"observation-status.html\">registered | preliminary | final | amended +</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"An estimate of the degree to which quality issues have impacted on the value reported (this element modifies the meaning of other elements)\" class=\"dict\" href=\"observation-definitions.html#Observation.reliability\"><span style=\"text-decoration: underline\"><b>reliability</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"observation-reliability.html\">ok | ongoing | early | questionable | calibrating | error +</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Indicates where on the subject's body the observation was made.\" class=\"dict\" href=\"observation-definitions.html#Observation.bodySite\"><b>bodySite</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-body-site.html\">Observed body part</a></span><span style=\"color: Gray\"> --></span></bodySite>\r\n <<a title=\"Indicates the mechanism used to perform the observation.\" class=\"dict\" href=\"observation-definitions.html#Observation.method\"><b>method</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-observation-methods.html\">How it was done</a></span><span style=\"color: Gray\"> --></span></method>\r\n <<a title=\"A unique identifier for the simple observation.\" class=\"dict\" href=\"observation-definitions.html#Observation.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Unique Id for this particular observation</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"The thing the observation is being made about.\" class=\"dict\" href=\"observation-definitions.html#Observation.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"group.html#Group\">Group</a>|<a href=\"device.html#Device\">Device</a>|<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">Who and/or what this is about</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"The specimen that was used when this observation was made.\" class=\"dict\" href=\"observation-definitions.html#Observation.specimen\"><b>specimen</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"specimen.html#Specimen\">Specimen</a>)</span> <span style=\"color: navy\">Specimen used for this observation</span><span style=\"color: Gray\"> --></span></specimen>\r\n <<a title=\"Who was responsible for asserting the observed value as "true".\" class=\"dict\" href=\"observation-definitions.html#Observation.performer\"><b>performer</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"device.html#Device\">Device</a>|<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">Who did the observation</span><span style=\"color: Gray\"> --></span></performer>\r\n <<a title=\"Guidance on how to interpret the value by comparison to a normal or recommended range.\" class=\"dict\" href=\"observation-definitions.html#Observation.referenceRange\"><b>referenceRange</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Provides guide for interpretation --></span>\r\n <<a title=\"The value of the low bound of the reference range. If this is omitted, the low bound of the reference range is assumed to be meaningless. E.g. <2.3.\" class=\"dict\" href=\"observation-definitions.html#Observation.referenceRange.low\"><b>low</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-3: Must have at least a low or a high (and no comparators)\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">Low Range, if relevant</span><span style=\"color: Gray\"> --></span></low>\r\n <<a title=\"The value of the high bound of the reference range. If this is omitted, the high bound of the reference range is assumed to be meaningless. E.g. >5.\" class=\"dict\" href=\"observation-definitions.html#Observation.referenceRange.high\"><b>high</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-3: Must have at least a low or a high (and no comparators)\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">High Range, if relevant</span><span style=\"color: Gray\"> --></span></high>\r\n <<a title=\"Code for the meaning of the reference range.\" class=\"dict\" href=\"observation-definitions.html#Observation.referenceRange.meaning\"><b>meaning</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-referencerange-meaning.html\">Indicates the meaning/use of this range of this range</a></span><span style=\"color: Gray\"> --></span></meaning>\r\n <<a title=\"The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.\" class=\"dict\" href=\"observation-definitions.html#Observation.referenceRange.age\"><b>age</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Range\">Range</a></span> <span style=\"color: navy\">Applicable age range, if relevant</span><span style=\"color: Gray\"> --></span></age>\r\n </referenceRange>\r\n <<a title=\"Related observations - either components, or previous observations, or statements of derivation.\" class=\"dict\" href=\"observation-definitions.html#Observation.related\"><b>related</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Observations related to this observation --></span>\r\n <<a title=\"A code specifying the kind of relationship that exists with the target observation.\" class=\"dict\" href=\"observation-definitions.html#Observation.related.type\"><b>type</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"observation-relationshiptypes.html\">has-component | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A reference to the observation that is related to this observation.\" class=\"dict\" href=\"observation-definitions.html#Observation.related.target\"><b>target</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"observation.html#Observation\">Observation</a>)</span> <span style=\"color: navy\">Observation that is related to this one</span><span style=\"color: Gray\"> --></span></target>\r\n </related>\r\n</Observation>\r\n</pre></div>"
},
{
"title": "\"operationoutcome\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/operationoutcome",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/operationoutcome.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"A collection of error, warning or information messages that result from a system action.\" class=\"dict\" href=\"operationoutcome-definitions.html#OperationOutcome\"><b>OperationOutcome</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"An error, warning or information message that results from a system action.\" class=\"dict\" href=\"operationoutcome-definitions.html#OperationOutcome.issue\"><b>issue</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..*</b></span> A single issue associated with the action --></span>\r\n <<a title=\"Indicates whether the issue indicates a variation from successful processing (this element modifies the meaning of other elements)\" class=\"dict\" href=\"operationoutcome-definitions.html#OperationOutcome.issue.severity\"><span style=\"text-decoration: underline\"><b>severity</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"issue-severity.html\">fatal | error | warning | information</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A code indicating the type of error, warning or information message.\" class=\"dict\" href=\"operationoutcome-definitions.html#OperationOutcome.issue.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Coding\">Coding</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"issue-type.html\">Error or warning code</a></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"Additional description of the issue.\" class=\"dict\" href=\"operationoutcome-definitions.html#OperationOutcome.issue.details\"><b>details</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Additional description of the issue</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A simple XPath limited to element names, repetition indicators and the default child access that identifies one of the elements in the resource that caused this issue to be raised.\" class=\"dict\" href=\"operationoutcome-definitions.html#OperationOutcome.issue.location\"><b>location</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: navy\">XPath of element(s) related to issue</span><span style=\"color: Gray\"> --></span>\r\n </issue>\r\n</OperationOutcome>\r\n</pre></div>"
},
"name": "operationoutcome",
"publisher": "FHIR Project",
"description": "Basic Profile. A collection of error, warning or information messages that result from a system action.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage Operation Outcomes are sets of error, warning and information messages that provide detailed information about the outcome of some attempted system operation. They are provided as a direct system response, or component of one, where they provide information about the outcome of the operation. \r\n\r\nSpecifically, OperationOutcomes are used in the following circumstances: \r\n\r\n* When an RESTful operation fails\r\n* As the response on a validation operation, to provide information about the outcomes\r\n* As part of a message response, usually when the message has not been processed correctly",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "OperationOutcome",
"publish": true,
"element": [
{
"path": "OperationOutcome",
"definition": {
"short": "Information about the success/failure of an action",
"formal": "A collection of error, warning or information messages that result from a system action.",
"comments": "Can result from the failure of a REST call or be part of the response message returned from a request message. If sent with extensions overriding particular issues, might even appear as part of a request message.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Grouping is handled through multiple repetitions from whatever context references the outcomes (no specific grouper required)"
}
]
}
},
{
"path": "OperationOutcome.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "OperationOutcome.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "OperationOutcome.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "OperationOutcome.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "OperationOutcome.issue",
"definition": {
"short": "A single issue associated with the action",
"formal": "An error, warning or information message that results from a system action.",
"min": 1,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "AcknowledgementDetail or Observation[classCode=\"ALRT\" and moodCode=\"EVN\"]"
},
{
"identity": "v2",
"map": "ERR"
}
]
}
},
{
"path": "OperationOutcome.issue.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "OperationOutcome.issue.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "OperationOutcome.issue.severity",
"definition": {
"short": "fatal | error | warning | information",
"formal": "Indicates whether the issue indicates a variation from successful processing.",
"comments": "This is labeled as \"Is Modifier\" because applications should not confuse hints and warnings with errors.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "IssueSeverity",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/issue-severity"
}
},
"mapping": [
{
"identity": "rim",
"map": "./typeCode[parent::AcknowledgmentDetail] or unique(./inboundRelationship[parent::Observation and typeCode='SUBJ' and isNormalActRelationship()]/source[classCode=\"OBS\" and moodCode=\"EVN\" and implies(code, ActCode#SEV and isNormalAct())/value[xsi:type=\"CD\"]"
},
{
"identity": "v2",
"map": "ERR-4"
}
]
}
},
{
"path": "OperationOutcome.issue.type",
"definition": {
"short": "Error or warning code",
"formal": "A code indicating the type of error, warning or information message.",
"comments": "Codes should only be defined at a level of granularity that reasonably allows distinct actions to be taken by the receiving system. If the response behavior of all systems is the same for two codes, the codes might as well be merged. The human-meaningful content of the issue is conveyed in .text.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isModifier": false,
"binding": {
"name": "IssueType",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/issue-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "./code"
},
{
"identity": "v2",
"map": "ERR-3, ERR-5"
}
]
}
},
{
"path": "OperationOutcome.issue.details",
"definition": {
"short": "Additional description of the issue",
"formal": "Additional description of the issue.",
"comments": "typically this field is used to provide details human-readable information about the error.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./text[parent::AcknowledgmentDetail]"
},
{
"identity": "v2",
"map": "ERR-8"
}
]
}
},
{
"path": "OperationOutcome.issue.location",
"definition": {
"short": "XPath of element(s) related to issue",
"formal": "A simple XPath limited to element names, repetition indicators and the default child access that identifies one of the elements in the resource that caused this issue to be raised.",
"comments": "The root of the XPath is the resource or bundle that generated OperationOutcome. Each XPath SHALL resolve to a single node. The XPath syntax is used whether the referenced instance is expressed in XML or JSON.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./location[parent::AcknowledgmentDetail]"
},
{
"identity": "v2",
"map": "ERR-2"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"A collection of error, warning or information messages that result from a system action.\" class=\"dict\" href=\"operationoutcome-definitions.html#OperationOutcome\"><b>OperationOutcome</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"An error, warning or information message that results from a system action.\" class=\"dict\" href=\"operationoutcome-definitions.html#OperationOutcome.issue\"><b>issue</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..*</b></span> A single issue associated with the action --></span>\r\n <<a title=\"Indicates whether the issue indicates a variation from successful processing (this element modifies the meaning of other elements)\" class=\"dict\" href=\"operationoutcome-definitions.html#OperationOutcome.issue.severity\"><span style=\"text-decoration: underline\"><b>severity</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"issue-severity.html\">fatal | error | warning | information</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A code indicating the type of error, warning or information message.\" class=\"dict\" href=\"operationoutcome-definitions.html#OperationOutcome.issue.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Coding\">Coding</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"issue-type.html\">Error or warning code</a></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"Additional description of the issue.\" class=\"dict\" href=\"operationoutcome-definitions.html#OperationOutcome.issue.details\"><b>details</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Additional description of the issue</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A simple XPath limited to element names, repetition indicators and the default child access that identifies one of the elements in the resource that caused this issue to be raised.\" class=\"dict\" href=\"operationoutcome-definitions.html#OperationOutcome.issue.location\"><b>location</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: navy\">XPath of element(s) related to issue</span><span style=\"color: Gray\"> --></span>\r\n </issue>\r\n</OperationOutcome>\r\n</pre></div>"
},
{
"title": "\"order\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/order",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/order.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"A request to perform an action.\" class=\"dict\" href=\"order-definitions.html#Order\"><b>Order</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Identifiers assigned to this order by the orderer or by the receiver.\" class=\"dict\" href=\"order-definitions.html#Order.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">\r\n Identifiers assigned to this order by the orderer or by the receiver</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"When the order was made.\" class=\"dict\" href=\"order-definitions.html#Order.date\"><b>date</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When the order was made</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Patient this order is about.\" class=\"dict\" href=\"order-definitions.html#Order.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Patient this order is about</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"Who initiated the order.\" class=\"dict\" href=\"order-definitions.html#Order.source\"><b>source</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">Who initiated the order</span><span style=\"color: Gray\"> --></span></source>\r\n <<a title=\"Who is intended to fulfill the order.\" class=\"dict\" href=\"order-definitions.html#Order.target\"><b>target</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>|<a href=\"device.html#Device\">Device</a>|<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">\r\n Who is intended to fulfill the order</span><span style=\"color: Gray\"> --></span></target>\r\n <<a title=\"Text - why the order was made.\" class=\"dict\" href=\"order-definitions.html#Order.reason_x_\"><b>reason[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a>|<a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">Text - why the order was made</span><span style=\"color: Gray\"> --></span></reason[x]>\r\n <<a title=\"If required by policy.\" class=\"dict\" href=\"order-definitions.html#Order.authority\"><b>authority</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">If required by policy</span><span style=\"color: Gray\"> --></span></authority>\r\n <<a title=\"When order should be fulfilled.\" class=\"dict\" href=\"order-definitions.html#Order.when\"><b>when</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> When order should be fulfilled --></span>\r\n <<a title=\"Code specifies when request should be done. The code may simply be a priority code.\" class=\"dict\" href=\"order-definitions.html#Order.when.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: Provide a code or a schedule, but not both\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">\r\n Code specifies when request should be done. The code may simply be a priority code</span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"A formal schedule.\" class=\"dict\" href=\"order-definitions.html#Order.when.schedule\"><b>schedule</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: Provide a code or a schedule, but not both\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Schedule\">Schedule</a></span> <span style=\"color: navy\">A formal schedule</span><span style=\"color: Gray\"> --></span></schedule>\r\n </when>\r\n <<a title=\"What action is being ordered.\" class=\"dict\" href=\"order-definitions.html#Order.detail\"><b>detail</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">What action is being ordered</span><span style=\"color: Gray\"> --></span></detail>\r\n</Order>\r\n</pre></div>"
},
"name": "order",
"publisher": "FHIR Project",
"description": "Basic Profile. A request to perform an action.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage An order resource describes a request that an action be performed. An order is expected to lead to one or more responses that describe the outcome of processing/handling the order. The order resource is focused on the process of actually requesting an action be performed; the actual action to be performed is detailed in a separate resource that contains the details. Note that orders are often called \"requests\", but this name is not used here since the word \"request\" is used differently elsewhere in this specification. \r\n\r\nNote that there are a variety of processes associated with making and processing orders. Some orders may be handled immediately by automated systems but most require real world actions by one or more humans. Some orders can only be processed when other real world actions happen, such as a patient actually presenting themselves so that the action to be performed can actually be performed. Often these real world dependencies are only implicit in the order details.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "Order",
"publish": true,
"element": [
{
"path": "Order",
"definition": {
"short": "A request to perform an action",
"formal": "A request to perform an action.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "ControlAct[classCode=ACTN, moodCode=RQO]"
}
]
}
},
{
"path": "Order.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Order.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Order.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "Order.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "Order.identifier",
"definition": {
"short": "Identifiers assigned to this order by the orderer or by the receiver",
"formal": "Identifiers assigned to this order by the orderer or by the receiver.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
}
},
{
"path": "Order.date",
"definition": {
"short": "When the order was made",
"formal": "When the order was made.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
},
{
"identity": "v2",
"map": "ORC-9"
}
]
}
},
{
"path": "Order.subject",
"definition": {
"short": "Patient this order is about",
"formal": "Patient this order is about.",
"comments": "May be left blank if the request reference identifies the patient, or if the request is not associated with a patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=PAT]"
},
{
"identity": "v2",
"map": "PID-3"
}
]
}
},
{
"path": "Order.source",
"definition": {
"short": "Who initiated the order",
"formal": "Who initiated the order.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
},
{
"identity": "v2",
"map": "ORC-12 / OBR-16 / RXO-14 / RXE-13 / PRT-5 (PRT-4-Participation='OP')"
}
]
}
},
{
"path": "Order.target",
"definition": {
"short": "Who is intended to fulfill the order",
"formal": "Who is intended to fulfill the order.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PFM].role"
},
{
"identity": "v2",
"map": "Unclear: MSH-5 / IPC-7 / BPO-8 / RXO-32 / RXE-40 / RXD-30 / RXG-11 / RXG-27 / PRT-8 (PRT-4-participation in { 'AP', 'DP', 'PO', 'RT' })"
}
]
}
},
{
"path": "Order.reason[x]",
"definition": {
"short": "Text - why the order was made",
"formal": "Text - why the order was made.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Any"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".reasonCode or .outboundRelationship[typeCode=RSON].target"
},
{
"identity": "v2",
"map": "ORC-16.2 / OBR-31.2 / BPO-13.2-BP / RXO-20.2 / RXE-27.2 / RXD-21.2 / RXG-22.2 / RXA-19.2"
}
]
}
},
{
"path": "Order.authority",
"definition": {
"short": "If required by policy",
"formal": "If required by policy.",
"comments": "reference will be constrained when suitable targets exist.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Any"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=RESP].role"
},
{
"identity": "v2",
"map": "if ordering provider, then ORC-12, OBR-16, etc."
}
]
}
},
{
"path": "Order.when",
"definition": {
"short": "When order should be fulfilled",
"formal": "When order should be fulfilled.",
"min": 0,
"max": "1",
"constraint": [
{
"key": "1",
"name": "Scheduling Details",
"severity": "error",
"human": "Provide a code or a schedule, but not both",
"xpath": "exists(f:code) != exists(f:schedule)"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "v2",
"map": "TQ1, TQ2"
}
]
}
},
{
"path": "Order.when.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Order.when.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Order.when.code",
"definition": {
"short": "Code specifies when request should be done. The code may simply be a priority code",
"formal": "Code specifies when request should be done. The code may simply be a priority code.",
"comments": "This is usually a local code agreed in the context of the ordering workflow.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "RequestedTime",
"isExtensible": true,
"conformance": "preferred",
"description": "When a requested action should be performed. E.g. STAT, daily, evenings, etc."
},
"mapping": [
{
"identity": "rim",
"map": "GTS is a coded value"
}
]
}
},
{
"path": "Order.when.schedule",
"definition": {
"short": "A formal schedule",
"formal": "A formal schedule.",
"min": 0,
"max": "1",
"type": [
{
"code": "Schedule"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "GTS is a complex schedule"
}
]
}
},
{
"path": "Order.detail",
"definition": {
"short": "What action is being ordered",
"formal": "What action is being ordered.",
"min": 1,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Any"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=SUBJ].target"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "authority",
"type": "reference",
"documentation": "If required by policy",
"xpath": "f:Order/f:authority"
},
{
"name": "date",
"type": "date",
"documentation": "When the order was made",
"xpath": "f:Order/f:date"
},
{
"name": "detail",
"type": "reference",
"documentation": "What action is being ordered",
"xpath": "f:Order/f:detail"
},
{
"name": "source",
"type": "reference",
"documentation": "Who initiated the order",
"xpath": "f:Order/f:source"
},
{
"name": "subject",
"type": "reference",
"documentation": "Patient this order is about",
"xpath": "f:Order/f:subject"
},
{
"name": "target",
"type": "reference",
"documentation": "Who is intended to fulfill the order",
"xpath": "f:Order/f:target"
},
{
"name": "when",
"type": "date",
"documentation": "A formal schedule",
"xpath": "f:Order/f:when/f:schedule"
},
{
"name": "when_code",
"type": "token",
"documentation": "Code specifies when request should be done. The code may simply be a priority code",
"xpath": "f:Order/f:when/f:code"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"A request to perform an action.\" class=\"dict\" href=\"order-definitions.html#Order\"><b>Order</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Identifiers assigned to this order by the orderer or by the receiver.\" class=\"dict\" href=\"order-definitions.html#Order.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">\r\n Identifiers assigned to this order by the orderer or by the receiver</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"When the order was made.\" class=\"dict\" href=\"order-definitions.html#Order.date\"><b>date</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When the order was made</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Patient this order is about.\" class=\"dict\" href=\"order-definitions.html#Order.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Patient this order is about</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"Who initiated the order.\" class=\"dict\" href=\"order-definitions.html#Order.source\"><b>source</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">Who initiated the order</span><span style=\"color: Gray\"> --></span></source>\r\n <<a title=\"Who is intended to fulfill the order.\" class=\"dict\" href=\"order-definitions.html#Order.target\"><b>target</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>|<a href=\"device.html#Device\">Device</a>|<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">\r\n Who is intended to fulfill the order</span><span style=\"color: Gray\"> --></span></target>\r\n <<a title=\"Text - why the order was made.\" class=\"dict\" href=\"order-definitions.html#Order.reason_x_\"><b>reason[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a>|<a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">Text - why the order was made</span><span style=\"color: Gray\"> --></span></reason[x]>\r\n <<a title=\"If required by policy.\" class=\"dict\" href=\"order-definitions.html#Order.authority\"><b>authority</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">If required by policy</span><span style=\"color: Gray\"> --></span></authority>\r\n <<a title=\"When order should be fulfilled.\" class=\"dict\" href=\"order-definitions.html#Order.when\"><b>when</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> When order should be fulfilled --></span>\r\n <<a title=\"Code specifies when request should be done. The code may simply be a priority code.\" class=\"dict\" href=\"order-definitions.html#Order.when.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: Provide a code or a schedule, but not both\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">\r\n Code specifies when request should be done. The code may simply be a priority code</span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"A formal schedule.\" class=\"dict\" href=\"order-definitions.html#Order.when.schedule\"><b>schedule</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: Provide a code or a schedule, but not both\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Schedule\">Schedule</a></span> <span style=\"color: navy\">A formal schedule</span><span style=\"color: Gray\"> --></span></schedule>\r\n </when>\r\n <<a title=\"What action is being ordered.\" class=\"dict\" href=\"order-definitions.html#Order.detail\"><b>detail</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">What action is being ordered</span><span style=\"color: Gray\"> --></span></detail>\r\n</Order>\r\n</pre></div>"
},
{
"title": "\"orderresponse\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/orderresponse",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/orderresponse.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"A response to an order.\" class=\"dict\" href=\"orderresponse-definitions.html#OrderResponse\"><b>OrderResponse</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Identifiers assigned to this order. The identifiers are usually assigned by the system responding to the order, but they may be provided or added to by other systems.\" class=\"dict\" href=\"orderresponse-definitions.html#OrderResponse.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">\r\n Identifiers assigned to this order by the orderer or by the receiver</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"A reference to the order that this is in response to.\" class=\"dict\" href=\"orderresponse-definitions.html#OrderResponse.request\"><b>request</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"order.html#Order\">Order</a>)</span> <span style=\"color: navy\">The order that this is a response to</span><span style=\"color: Gray\"> --></span></request>\r\n <<a title=\"The date and time at which this order response was made (created/posted).\" class=\"dict\" href=\"orderresponse-definitions.html#OrderResponse.date\"><b>date</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When the response was made</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The person, organization, or device credited with making the response.\" class=\"dict\" href=\"orderresponse-definitions.html#OrderResponse.who\"><b>who</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"organization.html#Organization\">Organization</a>|<a href=\"device.html#Device\">Device</a>)</span> <span style=\"color: navy\">Who made the response</span><span style=\"color: Gray\"> --></span></who>\r\n <<a title=\"A reference to an authority policy that is the reason for the response. Usually this is used when the order is rejected, to provide a reason for rejection.\" class=\"dict\" href=\"orderresponse-definitions.html#OrderResponse.authority_x_\"><b>authority[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a>|<a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">If required by policy</span><span style=\"color: Gray\"> --></span></authority[x]>\r\n <<a title=\"What this response says about the status of the original order (this element modifies the meaning of other elements)\" class=\"dict\" href=\"orderresponse-definitions.html#OrderResponse.code\"><span style=\"text-decoration: underline\"><b>code</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"order-outcome-code.html\">pending | review | rejected | error | accepted | cancelled | replaced | aborted | complete</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Additional description about the response - e.g. a text description provided by a human user when making decisions about the order.\" class=\"dict\" href=\"orderresponse-definitions.html#OrderResponse.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Additional description of the response</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Links to resources that provide details of the outcome of performing the order. E.g. Diagnostic Reports in a response that is made to an order that referenced a diagnostic order.\" class=\"dict\" href=\"orderresponse-definitions.html#OrderResponse.fulfillment\"><b>fulfillment</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">Details of the outcome of performing the order</span><span style=\"color: Gray\"> --></span></fulfillment>\r\n</OrderResponse>\r\n</pre></div>"
},
"name": "orderresponse",
"publisher": "FHIR Project",
"description": "Basic Profile. A response to an order.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage The response to an order indicates the outcome of processing the order itself - whether it was accepted or rejected, or is still in process. The order response resource does not itself convey or represent information that arises as a result of performing the actual order, but it may have references to other resources that do have this information, in order to link between the original order and its outcome.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "OrderResponse",
"publish": true,
"element": [
{
"path": "OrderResponse",
"definition": {
"short": "A response to an order",
"formal": "A response to an order.",
"comments": "There might be more than one response to an order.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "ControlAct[classCode=ACTN, moodCode=EVN]"
}
]
}
},
{
"path": "OrderResponse.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "OrderResponse.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "OrderResponse.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "OrderResponse.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "OrderResponse.identifier",
"definition": {
"short": "Identifiers assigned to this order by the orderer or by the receiver",
"formal": "Identifiers assigned to this order. The identifiers are usually assigned by the system responding to the order, but they may be provided or added to by other systems.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
}
},
{
"path": "OrderResponse.request",
"definition": {
"short": "The order that this is a response to",
"formal": "A reference to the order that this is in response to.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Order"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationships[typeCode=FLFS].target"
},
{
"identity": "v2",
"map": "ORC-2 / ORC-3, or OBR-2 | OBR-3"
}
]
}
},
{
"path": "OrderResponse.date",
"definition": {
"short": "When the response was made",
"formal": "The date and time at which this order response was made (created/posted).",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
},
{
"identity": "v2",
"map": "ORC-9"
}
]
}
},
{
"path": "OrderResponse.who",
"definition": {
"short": "Who made the response",
"formal": "The person, organization, or device credited with making the response.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
},
{
"identity": "v2",
"map": "Practitioner: ORC-19 | PRT / Organization: PRT"
}
]
}
},
{
"path": "OrderResponse.authority[x]",
"definition": {
"short": "If required by policy",
"formal": "A reference to an authority policy that is the reason for the response. Usually this is used when the order is rejected, to provide a reason for rejection.",
"comments": "reference will be constrained when suitable targets exist.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Any"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationships[typeCode=COVBY].target[classCode=POLICY, moodCode=EVN].code\n\nor\n\n.outboundRelationships[typeCode=COVBY].target[classCode=POLICY, moodCode=EVN]"
},
{
"identity": "v2",
"map": "Defined in FHIR as 'if required by policy'; unclear how this would map to V2 except ORC-19.9-action by.assigning authority or ORC-30-enterer authorization mode, neither of which exactly scales to a resource"
}
]
}
},
{
"path": "OrderResponse.code",
"definition": {
"short": "pending | review | rejected | error | accepted | cancelled | replaced | aborted | complete",
"formal": "What this response says about the status of the original order.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "OrderOutcomeStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/order-outcome-code"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code (different trigger events for different outcomes)"
},
{
"identity": "v2",
"map": "ORC-1 + ORC-5"
}
]
}
},
{
"path": "OrderResponse.description",
"definition": {
"short": "Additional description of the response",
"formal": "Additional description about the response - e.g. a text description provided by a human user when making decisions about the order.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".text"
},
{
"identity": "v2",
"map": "ORC-16.2-order control code reason.text"
}
]
}
},
{
"path": "OrderResponse.fulfillment",
"definition": {
"short": "Details of the outcome of performing the order",
"formal": "Links to resources that provide details of the outcome of performing the order. E.g. Diagnostic Reports in a response that is made to an order that referenced a diagnostic order.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Any"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=SUBJ]/target[moodCode=RQO]"
},
{
"identity": "v2",
"map": "OBR+OBX[n] / RXE / RXD / RXG / RXA / BPX / BTX"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "code",
"type": "token",
"documentation": "pending | review | rejected | error | accepted | cancelled | replaced | aborted | complete",
"xpath": "f:OrderResponse/f:code"
},
{
"name": "date",
"type": "date",
"documentation": "When the response was made",
"xpath": "f:OrderResponse/f:date"
},
{
"name": "fulfillment",
"type": "reference",
"documentation": "Details of the outcome of performing the order",
"xpath": "f:OrderResponse/f:fulfillment"
},
{
"name": "request",
"type": "reference",
"documentation": "The order that this is a response to",
"xpath": "f:OrderResponse/f:request"
},
{
"name": "who",
"type": "reference",
"documentation": "Who made the response",
"xpath": "f:OrderResponse/f:who"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"A response to an order.\" class=\"dict\" href=\"orderresponse-definitions.html#OrderResponse\"><b>OrderResponse</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Identifiers assigned to this order. The identifiers are usually assigned by the system responding to the order, but they may be provided or added to by other systems.\" class=\"dict\" href=\"orderresponse-definitions.html#OrderResponse.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">\r\n Identifiers assigned to this order by the orderer or by the receiver</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"A reference to the order that this is in response to.\" class=\"dict\" href=\"orderresponse-definitions.html#OrderResponse.request\"><b>request</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"order.html#Order\">Order</a>)</span> <span style=\"color: navy\">The order that this is a response to</span><span style=\"color: Gray\"> --></span></request>\r\n <<a title=\"The date and time at which this order response was made (created/posted).\" class=\"dict\" href=\"orderresponse-definitions.html#OrderResponse.date\"><b>date</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When the response was made</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The person, organization, or device credited with making the response.\" class=\"dict\" href=\"orderresponse-definitions.html#OrderResponse.who\"><b>who</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"organization.html#Organization\">Organization</a>|<a href=\"device.html#Device\">Device</a>)</span> <span style=\"color: navy\">Who made the response</span><span style=\"color: Gray\"> --></span></who>\r\n <<a title=\"A reference to an authority policy that is the reason for the response. Usually this is used when the order is rejected, to provide a reason for rejection.\" class=\"dict\" href=\"orderresponse-definitions.html#OrderResponse.authority_x_\"><b>authority[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a>|<a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">If required by policy</span><span style=\"color: Gray\"> --></span></authority[x]>\r\n <<a title=\"What this response says about the status of the original order (this element modifies the meaning of other elements)\" class=\"dict\" href=\"orderresponse-definitions.html#OrderResponse.code\"><span style=\"text-decoration: underline\"><b>code</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"order-outcome-code.html\">pending | review | rejected | error | accepted | cancelled | replaced | aborted | complete</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Additional description about the response - e.g. a text description provided by a human user when making decisions about the order.\" class=\"dict\" href=\"orderresponse-definitions.html#OrderResponse.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Additional description of the response</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Links to resources that provide details of the outcome of performing the order. E.g. Diagnostic Reports in a response that is made to an order that referenced a diagnostic order.\" class=\"dict\" href=\"orderresponse-definitions.html#OrderResponse.fulfillment\"><b>fulfillment</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">Details of the outcome of performing the order</span><span style=\"color: Gray\"> --></span></fulfillment>\r\n</OrderResponse>\r\n</pre></div>"
},
{
"title": "\"organization\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/organization",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/organization.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc.\" class=\"dict\" href=\"organization-definitions.html#Organization\"><b>Organization</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Identifier for the organization that is used to identify the organization across multiple disparate systems.\" class=\"dict\" href=\"organization-definitions.html#Organization.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: The organization SHALL at least have a name or an id, and possibly more than one\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Identifies this organization across multiple systems</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"A name associated with the organization.\" class=\"dict\" href=\"organization-definitions.html#Organization.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: The organization SHALL at least have a name or an id, and possibly more than one\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Name used for the organization</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The kind of organization that this is.\" class=\"dict\" href=\"organization-definitions.html#Organization.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-organization-type.html\">Kind of organization</a></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"A contact detail for the organization.\" class=\"dict\" href=\"organization-definitions.html#Organization.telecom\"><b>telecom</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-3: The telecom of an organization can never be of use 'home'\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">A contact detail for the organization</span><span style=\"color: Gray\"> --></span></telecom>\r\n <<a title=\"An address for the organization.\" class=\"dict\" href=\"organization-definitions.html#Organization.address\"><b>address</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: An address of an organization can never be of use 'home'\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Address\">Address</a></span> <span style=\"color: navy\">An address for the organization</span><span style=\"color: Gray\"> --></span></address>\r\n <<a title=\"The organization of which this organization forms a part.\" class=\"dict\" href=\"organization-definitions.html#Organization.partOf\"><b>partOf</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">\r\n The organization of which this organization forms a part</span><span style=\"color: Gray\"> --></span></partOf>\r\n <<a title=\"Contact for the organization for a certain purpose.\" class=\"dict\" href=\"organization-definitions.html#Organization.contact\"><b>contact</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Contact for the organization for a certain purpose --></span>\r\n <<a title=\"Indicates a purpose for which the contact can be reached.\" class=\"dict\" href=\"organization-definitions.html#Organization.contact.purpose\"><b>purpose</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-contactentity-type.html\">The type of contact</a></span><span style=\"color: Gray\"> --></span></purpose>\r\n <<a title=\"A name associated with the contact.\" class=\"dict\" href=\"organization-definitions.html#Organization.contact.name\"><b>name</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#HumanName\">HumanName</a></span> <span style=\"color: navy\">A name associated with the contact</span><span style=\"color: Gray\"> --></span></name>\r\n <<a title=\"A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.\" class=\"dict\" href=\"organization-definitions.html#Organization.contact.telecom\"><b>telecom</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">Contact details (telephone, email, etc) for a contact</span><span style=\"color: Gray\"> --></span></telecom>\r\n <<a title=\"Visiting or postal addresses for the contact.\" class=\"dict\" href=\"organization-definitions.html#Organization.contact.address\"><b>address</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Address\">Address</a></span> <span style=\"color: navy\">Visiting or postal addresses for the contact</span><span style=\"color: Gray\"> --></span></address>\r\n <<a title=\"Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.\" class=\"dict\" href=\"organization-definitions.html#Organization.contact.gender\"><b>gender</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administrative-gender.html\">Gender for administrative purposes</a></span><span style=\"color: Gray\"> --></span></gender>\r\n </contact>\r\n <<a title=\"Location(s) the organization uses to provide services.\" class=\"dict\" href=\"organization-definitions.html#Organization.location\"><b>location</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">\r\n Location(s) the organization uses to provide services</span><span style=\"color: Gray\"> --></span></location>\r\n <<a title=\"Whether the organization's record is still in active use (this element modifies the meaning of other elements)\" class=\"dict\" href=\"organization-definitions.html#Organization.active\"><span style=\"text-decoration: underline\"><b>active</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Whether the organization's record is still in active use</span><span style=\"color: Gray\"> --></span>\r\n</Organization>\r\n</pre></div>"
},
"name": "organization",
"publisher": "FHIR Project",
"description": "Basic Profile. A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage This resource may be used in a shared registry of contact and other information for various organizations or it can be used merely as a support for other resources that need to reference organizations, perhaps as a document, message or as a contained resource. If using a registry approach, it's entirely possible for multiple registries to exist, each dealing with different types or levels of organization.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
},
{
"identity": "servd",
"uri": "http://www.omg.org/spec/ServD/1.0/",
"name": "ServD"
}
],
"structure": [
{
"type": "Organization",
"publish": true,
"element": [
{
"path": "Organization",
"definition": {
"short": "A grouping of people or organizations with a common purpose",
"formal": "A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"constraint": [
{
"key": "1",
"name": "AtLeastANameOrId",
"severity": "error",
"human": "The organization SHALL at least have a name or an id, and possibly more than one",
"xpath": "count(f:identifier | f:name) > 0"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Organization(classCode=ORG, determinerCode=INST)"
},
{
"identity": "v2",
"map": "(also see master files messages)"
},
{
"identity": "servd",
"map": "Organization"
}
]
}
},
{
"path": "Organization.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Organization.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Organization.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "Organization.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "Organization.identifier",
"definition": {
"short": "Identifies this organization across multiple systems",
"formal": "Identifier for the organization that is used to identify the organization across multiple disparate systems.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".scopes[Role](classCode=IDENT)"
},
{
"identity": "v2",
"map": "XON.10 Organization Identifier / XON.3 ID Number"
},
{
"identity": "servd",
"map": "./Identifiers"
}
]
}
},
{
"path": "Organization.name",
"definition": {
"short": "Name used for the organization",
"formal": "A name associated with the organization.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".name"
},
{
"identity": "v2",
"map": "XON.1 Organization Name"
},
{
"identity": "servd",
"map": ".PreferredName/Name"
}
]
}
},
{
"path": "Organization.type",
"definition": {
"short": "Kind of organization",
"formal": "The kind of organization that this is.",
"comments": "Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "OrganizationType",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/organization-type"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "v2",
"map": "No equivalent in v2"
},
{
"identity": "servd",
"map": "n/a"
}
]
}
},
{
"path": "Organization.telecom",
"definition": {
"short": "A contact detail for the organization",
"formal": "A contact detail for the organization.",
"comments": "The use code home is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.",
"min": 0,
"max": "*",
"type": [
{
"code": "Contact"
}
],
"constraint": [
{
"key": "3",
"name": "NoHomeUseTelecom",
"severity": "error",
"human": "The telecom of an organization can never be of use 'home'",
"xpath": "count(f:use[@value='home']) = 0"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".telecom"
},
{
"identity": "v2",
"map": "No authoritative equivalent in V2.x"
},
{
"identity": "servd",
"map": "./ContactPoints"
}
]
}
},
{
"path": "Organization.address",
"definition": {
"short": "An address for the organization",
"formal": "An address for the organization.",
"comments": "Organization may have multiple addresses with different uses or applicable periods. The use code home is not to be used.",
"min": 0,
"max": "*",
"type": [
{
"code": "Address"
}
],
"constraint": [
{
"key": "2",
"name": "NoHomeUseAddress",
"severity": "error",
"human": "An address of an organization can never be of use 'home'",
"xpath": "count(f:use[@value='home']) = 0"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".address"
},
{
"identity": "v2",
"map": "No authoritative equivalent in V2.x; some V2.x segments such as OBX might provide a serialized instance value"
},
{
"identity": "servd",
"map": "./PrimaryAddress and ./OtherAddresses"
}
]
}
},
{
"path": "Organization.partOf",
"definition": {
"short": "The organization of which this organization forms a part",
"formal": "The organization of which this organization forms a part.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".playedBy[classCode=Part].scoper"
},
{
"identity": "v2",
"map": "No equivalent in V2.x"
},
{
"identity": "servd",
"map": "n/a"
}
]
}
},
{
"path": "Organization.contact",
"definition": {
"short": "Contact for the organization for a certain purpose",
"formal": "Contact for the organization for a certain purpose.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".contactParty"
}
]
}
},
{
"path": "Organization.contact.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Organization.contact.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Organization.contact.purpose",
"definition": {
"short": "The type of contact",
"formal": "Indicates a purpose for which the contact can be reached.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ContactPartyType",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/contactentity-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "./type"
}
]
}
},
{
"path": "Organization.contact.name",
"definition": {
"short": "A name associated with the contact",
"formal": "A name associated with the contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "HumanName"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./name"
},
{
"identity": "v2",
"map": "PID-5, PID-9"
}
]
}
},
{
"path": "Organization.contact.telecom",
"definition": {
"short": "Contact details (telephone, email, etc) for a contact",
"formal": "A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.",
"min": 0,
"max": "*",
"type": [
{
"code": "Contact"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./telecom"
},
{
"identity": "v2",
"map": "PID-13, PID-14"
}
]
}
},
{
"path": "Organization.contact.address",
"definition": {
"short": "Visiting or postal addresses for the contact",
"formal": "Visiting or postal addresses for the contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "Address"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./addr"
},
{
"identity": "v2",
"map": "PID-11"
}
]
}
},
{
"path": "Organization.contact.gender",
"definition": {
"short": "Gender for administrative purposes",
"formal": "Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "AdministrativeGender",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/administrative-gender"
}
},
"mapping": [
{
"identity": "rim",
"map": "./administrativeGender"
},
{
"identity": "v2",
"map": "PID-8"
}
]
}
},
{
"path": "Organization.location",
"definition": {
"short": "Location(s) the organization uses to provide services",
"formal": "Location(s) the organization uses to provide services.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Location"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".scopedBy[classCode=LocatedEntity].scoper"
},
{
"identity": "servd",
"map": "./Sites"
}
]
}
},
{
"path": "Organization.active",
"definition": {
"short": "Whether the organization's record is still in active use",
"formal": "Whether the organization's record is still in active use.",
"comments": "Default is true.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": ".status"
},
{
"identity": "v2",
"map": "No equivalent in V2.x"
},
{
"identity": "servd",
"map": "./Status (however this concept in ServD more covers why the organization is active or not, could be delisted, deregistered, not operational yet) this could alternatively be derived from ./StartDate and ./EndDate and given a context date."
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "active",
"type": "token",
"documentation": "Whether the organization's record is active",
"xpath": "f:Organization/f:active"
},
{
"name": "identifier",
"type": "token",
"documentation": "Any identifier for the organization (not the accreditation issuer's identifier)",
"xpath": "f:Organization/f:identifier"
},
{
"name": "name",
"type": "string",
"documentation": "A portion of the organization's name",
"xpath": "f:Organization/f:name"
},
{
"name": "partof",
"type": "reference",
"documentation": "Search all organizations that are part of the given organization",
"xpath": "f:Organization/f:partOf"
},
{
"name": "phonetic",
"type": "string",
"documentation": "A portion of the organization's name using some kind of phonetic matching algorithm"
},
{
"name": "type",
"type": "token",
"documentation": "A code for the type of organization",
"xpath": "f:Organization/f:type"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc.\" class=\"dict\" href=\"organization-definitions.html#Organization\"><b>Organization</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Identifier for the organization that is used to identify the organization across multiple disparate systems.\" class=\"dict\" href=\"organization-definitions.html#Organization.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: The organization SHALL at least have a name or an id, and possibly more than one\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Identifies this organization across multiple systems</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"A name associated with the organization.\" class=\"dict\" href=\"organization-definitions.html#Organization.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: The organization SHALL at least have a name or an id, and possibly more than one\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Name used for the organization</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The kind of organization that this is.\" class=\"dict\" href=\"organization-definitions.html#Organization.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-organization-type.html\">Kind of organization</a></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"A contact detail for the organization.\" class=\"dict\" href=\"organization-definitions.html#Organization.telecom\"><b>telecom</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-3: The telecom of an organization can never be of use 'home'\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">A contact detail for the organization</span><span style=\"color: Gray\"> --></span></telecom>\r\n <<a title=\"An address for the organization.\" class=\"dict\" href=\"organization-definitions.html#Organization.address\"><b>address</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: An address of an organization can never be of use 'home'\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Address\">Address</a></span> <span style=\"color: navy\">An address for the organization</span><span style=\"color: Gray\"> --></span></address>\r\n <<a title=\"The organization of which this organization forms a part.\" class=\"dict\" href=\"organization-definitions.html#Organization.partOf\"><b>partOf</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">\r\n The organization of which this organization forms a part</span><span style=\"color: Gray\"> --></span></partOf>\r\n <<a title=\"Contact for the organization for a certain purpose.\" class=\"dict\" href=\"organization-definitions.html#Organization.contact\"><b>contact</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Contact for the organization for a certain purpose --></span>\r\n <<a title=\"Indicates a purpose for which the contact can be reached.\" class=\"dict\" href=\"organization-definitions.html#Organization.contact.purpose\"><b>purpose</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-contactentity-type.html\">The type of contact</a></span><span style=\"color: Gray\"> --></span></purpose>\r\n <<a title=\"A name associated with the contact.\" class=\"dict\" href=\"organization-definitions.html#Organization.contact.name\"><b>name</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#HumanName\">HumanName</a></span> <span style=\"color: navy\">A name associated with the contact</span><span style=\"color: Gray\"> --></span></name>\r\n <<a title=\"A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.\" class=\"dict\" href=\"organization-definitions.html#Organization.contact.telecom\"><b>telecom</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">Contact details (telephone, email, etc) for a contact</span><span style=\"color: Gray\"> --></span></telecom>\r\n <<a title=\"Visiting or postal addresses for the contact.\" class=\"dict\" href=\"organization-definitions.html#Organization.contact.address\"><b>address</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Address\">Address</a></span> <span style=\"color: navy\">Visiting or postal addresses for the contact</span><span style=\"color: Gray\"> --></span></address>\r\n <<a title=\"Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.\" class=\"dict\" href=\"organization-definitions.html#Organization.contact.gender\"><b>gender</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administrative-gender.html\">Gender for administrative purposes</a></span><span style=\"color: Gray\"> --></span></gender>\r\n </contact>\r\n <<a title=\"Location(s) the organization uses to provide services.\" class=\"dict\" href=\"organization-definitions.html#Organization.location\"><b>location</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">\r\n Location(s) the organization uses to provide services</span><span style=\"color: Gray\"> --></span></location>\r\n <<a title=\"Whether the organization's record is still in active use (this element modifies the meaning of other elements)\" class=\"dict\" href=\"organization-definitions.html#Organization.active\"><span style=\"text-decoration: underline\"><b>active</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Whether the organization's record is still in active use</span><span style=\"color: Gray\"> --></span>\r\n</Organization>\r\n</pre></div>"
},
{
"title": "\"other\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/other",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/other.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"Other is a conformant for handling resource concepts not yet defined for FHIR or outside HL7's scope of interest.\" class=\"dict\" href=\"other-definitions.html#Other\"><b>Other</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Identifier assigned to the resource for business purposes, outside the context of FHIR.\" class=\"dict\" href=\"other-definitions.html#Other.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Business identifier</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Identifies the 'type' of resource - equivalent to the resource name for other resources (this element modifies the meaning of other elements)\" class=\"dict\" href=\"other-definitions.html#Other.code\"><span style=\"text-decoration: underline\"><b>code</b></span></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-other-resource-type.html\">Kind of Resource</a></span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"Identifies the patient, practitioner, device or any other resource that is the "focus" of this resoruce.\" class=\"dict\" href=\"other-definitions.html#Other.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">Identifies the</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"Indicates who was responsible for creating the resource instance.\" class=\"dict\" href=\"other-definitions.html#Other.author\"><b>author</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"patient.html#Patient\">Patient</a>|<a href=\"relatedperson.html#RelatedPerson\">RelatedPerson</a>)</span> <span style=\"color: navy\">Who created</span><span style=\"color: Gray\"> --></span></author>\r\n <<a title=\"Identifies when the resource was first created.\" class=\"dict\" href=\"other-definitions.html#Other.created\"><b>created</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#date\">date</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When created</span><span style=\"color: Gray\"> --></span>\r\n</Other>\r\n</pre></div>"
},
"name": "other",
"publisher": "FHIR Project",
"description": "Basic Profile. Other is a conformant for handling resource concepts not yet defined for FHIR or outside HL7's scope of interest.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage Other is a special type of resource. Unlike all other resources, it doesn't correspond to a specific identifiable real-world concept. Instead, it's a placeholder for any resource-like concept that isn't already defined in the HL7 specification. \r\n\r\nThe Other resource is intended for use in two circumstances: \r\n\r\n* When an implementer needs a resource concept that is likely to be defined by HL7 in the future but they have not yet done so (due to bandwidth issues, lack of sufficient requirements, lower prioritization, etc.)\r\n* When the resource concept falls \"outside the 99%\" - i.e. less than 1% of the systems that use FHIR are likely to ever make use of the resource. To keep the specification manageable, it cannot incorporate every esoteric requirement that might be needed in some implementation somewhere. This set of resources likely won't ever be officially defined in HL7.\r\nThere's also a third circumstance: An implementer wishes to convey information that could/should be conveyed using a standard resource, however they want to represent the information in a custom format that isn't aligned with the official resource's elements. While this resource would be the preferred way of meeting that use-case because it will at least be wire-format compatible, such a use would not be conformant because making use of the Other resource would prevent the healthcare-related information from being safely processed, queried and analyzed by other conformant systems. \r\n\r\nImplementers don't really need to be concerned with one of the two categories their desired resource fits within. If they need a resource and it doesn't yet exist, they should use Other.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"structure": [
{
"type": "Other",
"publish": true,
"element": [
{
"path": "Other",
"definition": {
"short": "Resource for non-supported content",
"formal": "Other is a conformant for handling resource concepts not yet defined for FHIR or outside HL7's scope of interest.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Act, Entity or Role"
}
]
}
},
{
"path": "Other.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Other.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Other.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "Other.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "Other.identifier",
"definition": {
"short": "Business identifier",
"formal": "Identifier assigned to the resource for business purposes, outside the context of FHIR.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./identifier"
}
]
}
},
{
"path": "Other.code",
"definition": {
"short": "Kind of Resource",
"formal": "Identifies the 'type' of resource - equivalent to the resource name for other resources.",
"comments": "Because resource references will only be able to indicate 'Other', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": true,
"binding": {
"name": "OtherResourceType",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/other-resource-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "./code"
}
]
}
},
{
"path": "Other.subject",
"definition": {
"short": "Identifies the",
"formal": "Identifies the patient, practitioner, device or any other resource that is the \"focus\" of this resoruce.",
"comments": "Optional as not all resources potential resources will have subjects. Resources associated with multiple subjects can handle this via extension.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Any"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./participation[typeCode='SBJ'] (possibly through a ControlAct and Role)"
}
]
}
},
{
"path": "Other.author",
"definition": {
"short": "Who created",
"formal": "Indicates who was responsible for creating the resource instance.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/RelatedPerson"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./participation[typeCode='SUB'] (possibly through a ControlAct and Role)"
}
]
}
},
{
"path": "Other.created",
"definition": {
"short": "When created",
"formal": "Identifies when the resource was first created.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./participation[typeCode='AUT']/time (possibly through a ControlAct and Role)"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "code",
"type": "token",
"documentation": "Kind of Resource",
"xpath": "f:Other/f:code"
},
{
"name": "created",
"type": "date",
"documentation": "When created",
"xpath": "f:Other/f:created"
},
{
"name": "subject",
"type": "reference",
"documentation": "Identifies the",
"xpath": "f:Other/f:subject"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"Other is a conformant for handling resource concepts not yet defined for FHIR or outside HL7's scope of interest.\" class=\"dict\" href=\"other-definitions.html#Other\"><b>Other</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Identifier assigned to the resource for business purposes, outside the context of FHIR.\" class=\"dict\" href=\"other-definitions.html#Other.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Business identifier</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Identifies the 'type' of resource - equivalent to the resource name for other resources (this element modifies the meaning of other elements)\" class=\"dict\" href=\"other-definitions.html#Other.code\"><span style=\"text-decoration: underline\"><b>code</b></span></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-other-resource-type.html\">Kind of Resource</a></span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"Identifies the patient, practitioner, device or any other resource that is the "focus" of this resoruce.\" class=\"dict\" href=\"other-definitions.html#Other.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">Identifies the</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"Indicates who was responsible for creating the resource instance.\" class=\"dict\" href=\"other-definitions.html#Other.author\"><b>author</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"patient.html#Patient\">Patient</a>|<a href=\"relatedperson.html#RelatedPerson\">RelatedPerson</a>)</span> <span style=\"color: navy\">Who created</span><span style=\"color: Gray\"> --></span></author>\r\n <<a title=\"Identifies when the resource was first created.\" class=\"dict\" href=\"other-definitions.html#Other.created\"><b>created</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#date\">date</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When created</span><span style=\"color: Gray\"> --></span>\r\n</Other>\r\n</pre></div>"
},
{
"title": "\"patient\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/patient",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/patient.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"Demographics and other administrative information about a person or animal receiving care or other health-related services.\" class=\"dict\" href=\"patient-definitions.html#Patient\"><b>Patient</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"An identifier that applies to this person as a patient.\" class=\"dict\" href=\"patient-definitions.html#Patient.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">An identifier for the person as this patient<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"A name associated with the individual.\" class=\"dict\" href=\"patient-definitions.html#Patient.name\"><b>name</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#HumanName\">HumanName</a></span> <span style=\"color: navy\">A name associated with the patient<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></name>\r\n <<a title=\"A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.\" class=\"dict\" href=\"patient-definitions.html#Patient.telecom\"><b>telecom</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">A contact detail for the individual<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></telecom>\r\n <<a title=\"Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.\" class=\"dict\" href=\"patient-definitions.html#Patient.gender\"><b>gender</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administrative-gender.html\">Gender for administrative purposes<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></gender>\r\n <<a title=\"The date and time of birth for the individual.\" class=\"dict\" href=\"patient-definitions.html#Patient.birthDate\"><b>birthDate</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">The date and time of birth for the individual<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Indicates if the individual is deceased or not (this element modifies the meaning of other elements)\" class=\"dict\" href=\"patient-definitions.html#Patient.deceased_x_\"><span style=\"text-decoration: underline\"><b>deceased[x]</b></span></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a>|<a href=\"datatypes.html#dateTime\">dateTime</a></span> <span style=\"color: navy\">Indicates if the individual is deceased or not<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></deceased[x]>\r\n <<a title=\"Addresses for the individual.\" class=\"dict\" href=\"patient-definitions.html#Patient.address\"><b>address</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Address\">Address</a></span> <span style=\"color: navy\">Addresses for the individual<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></address>\r\n <<a title=\"This field contains a patient's most recent marital (civil) status.\" class=\"dict\" href=\"patient-definitions.html#Patient.maritalStatus\"><b>maritalStatus</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-marital-status.html\">Marital (civil) status of a person<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></maritalStatus>\r\n <<a title=\"Indicates whether the patient is part of a multiple or indicates the actual birth order.\" class=\"dict\" href=\"patient-definitions.html#Patient.multipleBirth_x_\"><b>multipleBirth[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a>|<a href=\"datatypes.html#integer\">integer</a></span> <span style=\"color: navy\">\r\n Whether patient is part of a multiple birth<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></multipleBirth[x]>\r\n <<a title=\"Image of the person.\" class=\"dict\" href=\"patient-definitions.html#Patient.photo\"><b>photo</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Attachment\">Attachment</a></span> <span style=\"color: navy\">Image of the person</span><span style=\"color: Gray\"> --></span></photo>\r\n <<a title=\"A contact party (e.g. guardian, partner, friend) for the patient.\" class=\"dict\" href=\"patient-definitions.html#Patient.contact\"><b>contact</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> A contact party (e.g. guardian, partner, friend) for the patient --></span>\r\n <<a title=\"The nature of the relationship between the patient and the contact person.\" class=\"dict\" href=\"patient-definitions.html#Patient.contact.relationship\"><b>relationship</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-patient-contact-relationship.html\">The kind of relationship</a></span><span style=\"color: Gray\"> --></span></relationship>\r\n <<a title=\"A name associated with the person.\" class=\"dict\" href=\"patient-definitions.html#Patient.contact.name\"><b>name</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#HumanName\">HumanName</a></span> <span style=\"color: navy\">A name associated with the person</span><span style=\"color: Gray\"> --></span></name>\r\n <<a title=\"A contact detail for the person, e.g. a telephone number or an email address.\" class=\"dict\" href=\"patient-definitions.html#Patient.contact.telecom\"><b>telecom</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">A contact detail for the person</span><span style=\"color: Gray\"> --></span></telecom>\r\n <<a title=\"Address for the contact person.\" class=\"dict\" href=\"patient-definitions.html#Patient.contact.address\"><b>address</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Address\">Address</a></span> <span style=\"color: navy\">Address for the contact person</span><span style=\"color: Gray\"> --></span></address>\r\n <<a title=\"Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.\" class=\"dict\" href=\"patient-definitions.html#Patient.contact.gender\"><b>gender</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administrative-gender.html\">Gender for administrative purposes</a></span><span style=\"color: Gray\"> --></span></gender>\r\n <<a title=\"Organization on behalf of which the contact is acting or for which the contact is working.\" class=\"dict\" href=\"patient-definitions.html#Patient.contact.organization\"><b>organization</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: SHALL at least contain a contact's details or a reference to an organization\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">\r\n Organization that is associated with the contact</span><span style=\"color: Gray\"> --></span></organization>\r\n </contact>\r\n <<a title=\"This element has a value if the patient is an animal (this element modifies the meaning of other elements)\" class=\"dict\" href=\"patient-definitions.html#Patient.animal\"><span style=\"text-decoration: underline\"><b>animal</b></span></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> If this patient is an animal (non-human)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span> --></span>\r\n <<a title=\"Identifies the high level categorization of the kind of animal.\" class=\"dict\" href=\"patient-definitions.html#Patient.animal.species\"><b>species</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-animal-species.html\">E.g. Dog, Cow<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></species>\r\n <<a title=\"Identifies the detailed categorization of the kind of animal.\" class=\"dict\" href=\"patient-definitions.html#Patient.animal.breed\"><b>breed</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-animal-breeds.html\">E.g. Poodle, Angus<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></breed>\r\n <<a title=\"Indicates the current state of the animal's reproductive organs.\" class=\"dict\" href=\"patient-definitions.html#Patient.animal.genderStatus\"><b>genderStatus</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-animal-genderstatus.html\">E.g. Neutered, Intact<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></genderStatus>\r\n </animal>\r\n <<a title=\"Languages which may be used to communicate with the patient about his or her health.\" class=\"dict\" href=\"patient-definitions.html#Patient.communication\"><b>communication</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://tools.ietf.org/html/bcp47.html\">Languages which may be used to communicate with the patient about his or her health</a></span><span style=\"color: Gray\"> --></span></communication>\r\n <<a title=\"Patient's nominated care provider.\" class=\"dict\" href=\"patient-definitions.html#Patient.careProvider\"><b>careProvider</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>|<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">\r\n Patient's nominated care provider</span><span style=\"color: Gray\"> --></span></careProvider>\r\n <<a title=\"Organization that is the custodian of the patient record.\" class=\"dict\" href=\"patient-definitions.html#Patient.managingOrganization\"><b>managingOrganization</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">\r\n Organization that is the custodian of the patient record<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></managingOrganization>\r\n <<a title=\"Link to another patient resource that concerns the same actual person (this element modifies the meaning of other elements)\" class=\"dict\" href=\"patient-definitions.html#Patient.link\"><span style=\"text-decoration: underline\"><b>link</b></span></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Link to another patient resource that concerns the same actual person<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span> --></span>\r\n <<a title=\"The other patient resource that the link refers to (this element modifies the meaning of other elements)\" class=\"dict\" href=\"patient-definitions.html#Patient.link.other\"><span style=\"text-decoration: underline\"><b>other</b></span></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">The other patient resource that the link refers to<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></other>\r\n <<a title=\"The type of link between this patient resource and another patient resource (this element modifies the meaning of other elements)\" class=\"dict\" href=\"patient-definitions.html#Patient.link.type\"><span style=\"text-decoration: underline\"><b>type</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"link-type.html\">replace | refer | seealso - type of link<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span>\r\n </link>\r\n <<a title=\"Whether this patient record is in active use (this element modifies the meaning of other elements)\" class=\"dict\" href=\"patient-definitions.html#Patient.active\"><span style=\"text-decoration: underline\"><b>active</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Whether this patient's record is in active use<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n</Patient>\r\n</pre></div>"
},
"name": "patient",
"publisher": "FHIR Project",
"description": "Basic Profile. Demographics and other administrative information about a person or animal receiving care or other health-related services.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage This Resource covers data about persons and animals involved in a wide range of health-related activities, including: \r\n\r\n* Curative activities\r\n* Psychiatric care\r\n* Social services\r\n* Pregnancy care\r\n* Nursing and assisted living\r\n* Dietary services\r\n* Tracking of personal health and exercise data\r\nThe data in the Resource covers the \"who\" information about the patient: its attributes are focused on the demographic information necessary to support the administrative, financial and logistic procedures. A Patient record is generally created and maintained by each organization providing care for a patient. A person or animal receiving care at multiple organizations may therefore have its information present in multiple Patient Resources.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "Patient",
"publish": true,
"element": [
{
"path": "Patient",
"definition": {
"short": "Information about a person or animal receiving health care services",
"formal": "Demographics and other administrative information about a person or animal receiving care or other health-related services.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Patient[classCode=PAT]"
}
]
}
},
{
"path": "Patient.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Patient.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Patient.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "Patient.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "Patient.identifier",
"definition": {
"short": "An identifier for the person as this patient",
"formal": "An identifier that applies to this person as a patient.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "id"
},
{
"identity": "v2",
"map": "PID-3"
}
]
}
},
{
"path": "Patient.name",
"definition": {
"short": "A name associated with the patient",
"formal": "A name associated with the individual.",
"comments": "Person may have multiple names with different uses or applicable periods.For animals, the name is a \"HumanName\" in the sense that is assigned and used by humans and has the same patterns.",
"min": 0,
"max": "*",
"type": [
{
"code": "HumanName"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "name"
},
{
"identity": "v2",
"map": "PID-5, PID-9"
}
]
}
},
{
"path": "Patient.telecom",
"definition": {
"short": "A contact detail for the individual",
"formal": "A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.",
"comments": "Person may have multiple ways to be contacted with different uses or applicable periods. \rMay need to have options for contacting the person urgently and also to help with identification. The address may not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).",
"min": 0,
"max": "*",
"type": [
{
"code": "Contact"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "telecom"
},
{
"identity": "v2",
"map": "PID-13, PID-14, PID-40"
}
]
}
},
{
"path": "Patient.gender",
"definition": {
"short": "Gender for administrative purposes",
"formal": "Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.",
"comments": "The gender may not match the biological sex as determined by genetics, or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than M and F, though the vast majority of systems and contexts only support M and F.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "AdministrativeGender",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/administrative-gender"
}
},
"mapping": [
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender"
},
{
"identity": "v2",
"map": "PID-8"
}
]
}
},
{
"path": "Patient.birthDate",
"definition": {
"short": "The date and time of birth for the individual",
"formal": "The date and time of birth for the individual.",
"comments": "At least an estimated year should be provided as a guess if the real dob is unknown.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime"
},
{
"identity": "v2",
"map": "PID-7"
}
]
}
},
{
"path": "Patient.deceased[x]",
"definition": {
"short": "Indicates if the individual is deceased or not",
"formal": "Indicates if the individual is deceased or not.",
"comments": "If there's no value in the instance it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
},
{
"code": "dateTime"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd,\rplayer[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime"
},
{
"identity": "v2",
"map": "PID-30\r (bool) and PID-29 (datetime)"
}
]
}
},
{
"path": "Patient.address",
"definition": {
"short": "Addresses for the individual",
"formal": "Addresses for the individual.",
"comments": "Person may have multiple addresses with different uses or applicable periods.",
"min": 0,
"max": "*",
"type": [
{
"code": "Address"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "addr"
},
{
"identity": "v2",
"map": "PID-11"
}
]
}
},
{
"path": "Patient.maritalStatus",
"definition": {
"short": "Marital (civil) status of a person",
"formal": "This field contains a patient's most recent marital (civil) status.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "MaritalStatus",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/marital-status"
}
},
"mapping": [
{
"identity": "rim",
"map": "player[classCode=PSN]/maritalStatusCode"
},
{
"identity": "v2",
"map": "PID-16"
}
]
}
},
{
"path": "Patient.multipleBirth[x]",
"definition": {
"short": "Whether patient is part of a multiple birth",
"formal": "Indicates whether the patient is part of a multiple or indicates the actual birth order.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
},
{
"code": "integer"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, \rplayer[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber"
},
{
"identity": "v2",
"map": "PID-24 (bool), PID-25 (integer)"
}
]
}
},
{
"path": "Patient.photo",
"definition": {
"short": "Image of the person",
"formal": "Image of the person.",
"min": 0,
"max": "*",
"type": [
{
"code": "Attachment"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc"
},
{
"identity": "v2",
"map": "OBX-5 - needs a profile"
}
]
}
},
{
"path": "Patient.contact",
"definition": {
"short": "A contact party (e.g. guardian, partner, friend) for the patient",
"formal": "A contact party (e.g. guardian, partner, friend) for the patient.",
"comments": "Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "1",
"name": "ContactNeedsDetails",
"severity": "error",
"human": "SHALL at least contain a contact's details or a reference to an organization",
"xpath": "f:name or f:telecom or f:address or f:organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]"
}
]
}
},
{
"path": "Patient.contact.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Patient.contact.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Patient.contact.relationship",
"definition": {
"short": "The kind of relationship",
"formal": "The nature of the relationship between the patient and the contact person.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ContactRelationship",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/patient-contact-relationship"
}
},
"mapping": [
{
"identity": "rim",
"map": "code"
},
{
"identity": "v2",
"map": "NK1-7, NK1-3"
}
]
}
},
{
"path": "Patient.contact.name",
"definition": {
"short": "A name associated with the person",
"formal": "A name associated with the person.",
"min": 0,
"max": "1",
"type": [
{
"code": "HumanName"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "name"
},
{
"identity": "v2",
"map": "NK1-2"
}
]
}
},
{
"path": "Patient.contact.telecom",
"definition": {
"short": "A contact detail for the person",
"formal": "A contact detail for the person, e.g. a telephone number or an email address.",
"comments": "Person may have multiple ways to be contacted with different uses or applicable periods. \rMay need to have options for contacting the person urgently, and also to help with identification.",
"min": 0,
"max": "*",
"type": [
{
"code": "Contact"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "telecom"
},
{
"identity": "v2",
"map": "NK1-5, NK1-6, NK1-40"
}
]
}
},
{
"path": "Patient.contact.address",
"definition": {
"short": "Address for the contact person",
"formal": "Address for the contact person.",
"min": 0,
"max": "1",
"type": [
{
"code": "Address"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "addr"
},
{
"identity": "v2",
"map": "NK1-4"
}
]
}
},
{
"path": "Patient.contact.gender",
"definition": {
"short": "Gender for administrative purposes",
"formal": "Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "AdministrativeGender",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/administrative-gender"
}
},
"mapping": [
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender"
},
{
"identity": "v2",
"map": "NK1-15"
}
]
}
},
{
"path": "Patient.contact.organization",
"definition": {
"short": "Organization that is associated with the contact",
"formal": "Organization on behalf of which the contact is acting or for which the contact is working.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "scoper"
},
{
"identity": "v2",
"map": "NK1-13, NK1-30, NK1-31, NK1-32, NK1-41"
}
]
}
},
{
"path": "Patient.animal",
"definition": {
"short": "If this patient is an animal (non-human)",
"formal": "This element has a value if the patient is an animal.",
"comments": "The animal element is labeled \"Is Modifier\" since patients may be non-human. Systems SHALL either handle patient details appropriately (e.g. inform users patient is not human) or reject non-human patient records.",
"min": 0,
"max": "1",
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "player[classCode=ANM]"
}
]
}
},
{
"path": "Patient.animal.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Patient.animal.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Patient.animal.species",
"definition": {
"short": "E.g. Dog, Cow",
"formal": "Identifies the high level categorization of the kind of animal.",
"comments": "If the patient is non-human, at least a species SHALL be specified.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "AnimalSpecies",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/animal-species"
}
},
"mapping": [
{
"identity": "rim",
"map": "code"
},
{
"identity": "v2",
"map": "PID-35"
}
]
}
},
{
"path": "Patient.animal.breed",
"definition": {
"short": "E.g. Poodle, Angus",
"formal": "Identifies the detailed categorization of the kind of animal.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "AnimalBreed",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/animal-breeds"
}
},
"mapping": [
{
"identity": "rim",
"map": "playedRole[classCode=GEN]/scoper[classCode=ANM, determinerCode=KIND]/code"
},
{
"identity": "v2",
"map": "PID-37"
}
]
}
},
{
"path": "Patient.animal.genderStatus",
"definition": {
"short": "E.g. Neutered, Intact",
"formal": "Indicates the current state of the animal's reproductive organs.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "AnimalGenderStatus",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/animal-genderstatus"
}
},
"mapping": [
{
"identity": "rim",
"map": "genderStatusCode"
},
{
"identity": "v2",
"map": "N/A"
}
]
}
},
{
"path": "Patient.communication",
"definition": {
"short": "Languages which may be used to communicate with the patient about his or her health",
"formal": "Languages which may be used to communicate with the patient about his or her health.",
"comments": "If no language is specified, this *implies* that the default local language is spoken.\rFor animals, language is not a relevant field, and should be absent from the instance.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "Language",
"isExtensible": false,
"conformance": "required",
"referenceUri": "http://tools.ietf.org/html/bcp47"
},
"mapping": [
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code"
},
{
"identity": "v2",
"map": "LAN-2"
}
]
}
},
{
"path": "Patient.careProvider",
"definition": {
"short": "Patient's nominated care provider",
"formal": "Patient's nominated care provider.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "subjectOf.CareEvent.performer.AssignedEntity"
}
]
}
},
{
"path": "Patient.managingOrganization",
"definition": {
"short": "Organization that is the custodian of the patient record",
"formal": "Organization that is the custodian of the patient record.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "scoper"
}
]
}
},
{
"path": "Patient.link",
"definition": {
"short": "Link to another patient resource that concerns the same actual person",
"formal": "Link to another patient resource that concerns the same actual person.",
"comments": "There is no assumption that linked patient records have mutual links.",
"min": 0,
"max": "*",
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "outboundLink"
}
]
}
},
{
"path": "Patient.link.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Patient.link.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Patient.link.other",
"definition": {
"short": "The other patient resource that the link refers to",
"formal": "The other patient resource that the link refers to.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "id"
},
{
"identity": "v2",
"map": "PID-3, MRG-1"
}
]
}
},
{
"path": "Patient.link.type",
"definition": {
"short": "replace | refer | seealso - type of link",
"formal": "The type of link between this patient resource and another patient resource.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "LinkType",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/link-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "typeCode"
}
]
}
},
{
"path": "Patient.active",
"definition": {
"short": "Whether this patient's record is in active use",
"formal": "Whether this patient record is in active use.",
"comments": "Default is true. If a record is inactive, and linked to an active record, then future patient/person/record updates should occur on the other patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "statusCode"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "active",
"type": "token",
"documentation": "Whether the patient record is active",
"xpath": "f:Patient/f:active"
},
{
"name": "address",
"type": "string",
"documentation": "An address in any kind of address/part of the patient",
"xpath": "f:Patient/f:address"
},
{
"name": "animal-breed",
"type": "token",
"documentation": "The breed for animal patients",
"xpath": "f:Patient/f:animal/f:breed"
},
{
"name": "animal-species",
"type": "token",
"documentation": "The species for animal patients",
"xpath": "f:Patient/f:animal/f:species"
},
{
"name": "birthdate",
"type": "date",
"documentation": "The patient's date of birth",
"xpath": "f:Patient/f:birthDate"
},
{
"name": "family",
"type": "string",
"documentation": "A portion of the family name of the patient",
"xpath": "f:Patient/f:name/f:family"
},
{
"name": "gender",
"type": "token",
"documentation": "Gender of the patient",
"xpath": "f:Patient/f:gender"
},
{
"name": "given",
"type": "string",
"documentation": "A portion of the given name of the patient",
"xpath": "f:Patient/f:name/f:given"
},
{
"name": "identifier",
"type": "token",
"documentation": "A patient identifier",
"xpath": "f:Patient/f:identifier"
},
{
"name": "language",
"type": "token",
"documentation": "Language code (irrespective of use value)",
"xpath": "f:Patient/f:communication"
},
{
"name": "link",
"type": "reference",
"documentation": "All patients linked to the given patient",
"xpath": "f:Patient/f:link/f:other"
},
{
"name": "name",
"type": "string",
"documentation": "A portion of either family or given name of the patient",
"xpath": "f:Patient/f:name"
},
{
"name": "phonetic",
"type": "string",
"documentation": "A portion of either family or given name using some kind of phonetic matching algorithm"
},
{
"name": "provider",
"type": "reference",
"documentation": "The organization at which this person is a patient",
"xpath": "f:Patient/f:managingOrganization"
},
{
"name": "telecom",
"type": "string",
"documentation": "The value in any kind of telecom details of the patient",
"xpath": "f:Patient/f:telecom"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"Demographics and other administrative information about a person or animal receiving care or other health-related services.\" class=\"dict\" href=\"patient-definitions.html#Patient\"><b>Patient</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"An identifier that applies to this person as a patient.\" class=\"dict\" href=\"patient-definitions.html#Patient.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">An identifier for the person as this patient<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"A name associated with the individual.\" class=\"dict\" href=\"patient-definitions.html#Patient.name\"><b>name</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#HumanName\">HumanName</a></span> <span style=\"color: navy\">A name associated with the patient<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></name>\r\n <<a title=\"A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.\" class=\"dict\" href=\"patient-definitions.html#Patient.telecom\"><b>telecom</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">A contact detail for the individual<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></telecom>\r\n <<a title=\"Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.\" class=\"dict\" href=\"patient-definitions.html#Patient.gender\"><b>gender</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administrative-gender.html\">Gender for administrative purposes<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></gender>\r\n <<a title=\"The date and time of birth for the individual.\" class=\"dict\" href=\"patient-definitions.html#Patient.birthDate\"><b>birthDate</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">The date and time of birth for the individual<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Indicates if the individual is deceased or not (this element modifies the meaning of other elements)\" class=\"dict\" href=\"patient-definitions.html#Patient.deceased_x_\"><span style=\"text-decoration: underline\"><b>deceased[x]</b></span></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a>|<a href=\"datatypes.html#dateTime\">dateTime</a></span> <span style=\"color: navy\">Indicates if the individual is deceased or not<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></deceased[x]>\r\n <<a title=\"Addresses for the individual.\" class=\"dict\" href=\"patient-definitions.html#Patient.address\"><b>address</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Address\">Address</a></span> <span style=\"color: navy\">Addresses for the individual<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></address>\r\n <<a title=\"This field contains a patient's most recent marital (civil) status.\" class=\"dict\" href=\"patient-definitions.html#Patient.maritalStatus\"><b>maritalStatus</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-marital-status.html\">Marital (civil) status of a person<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></maritalStatus>\r\n <<a title=\"Indicates whether the patient is part of a multiple or indicates the actual birth order.\" class=\"dict\" href=\"patient-definitions.html#Patient.multipleBirth_x_\"><b>multipleBirth[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a>|<a href=\"datatypes.html#integer\">integer</a></span> <span style=\"color: navy\">\r\n Whether patient is part of a multiple birth<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></multipleBirth[x]>\r\n <<a title=\"Image of the person.\" class=\"dict\" href=\"patient-definitions.html#Patient.photo\"><b>photo</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Attachment\">Attachment</a></span> <span style=\"color: navy\">Image of the person</span><span style=\"color: Gray\"> --></span></photo>\r\n <<a title=\"A contact party (e.g. guardian, partner, friend) for the patient.\" class=\"dict\" href=\"patient-definitions.html#Patient.contact\"><b>contact</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> A contact party (e.g. guardian, partner, friend) for the patient --></span>\r\n <<a title=\"The nature of the relationship between the patient and the contact person.\" class=\"dict\" href=\"patient-definitions.html#Patient.contact.relationship\"><b>relationship</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-patient-contact-relationship.html\">The kind of relationship</a></span><span style=\"color: Gray\"> --></span></relationship>\r\n <<a title=\"A name associated with the person.\" class=\"dict\" href=\"patient-definitions.html#Patient.contact.name\"><b>name</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#HumanName\">HumanName</a></span> <span style=\"color: navy\">A name associated with the person</span><span style=\"color: Gray\"> --></span></name>\r\n <<a title=\"A contact detail for the person, e.g. a telephone number or an email address.\" class=\"dict\" href=\"patient-definitions.html#Patient.contact.telecom\"><b>telecom</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">A contact detail for the person</span><span style=\"color: Gray\"> --></span></telecom>\r\n <<a title=\"Address for the contact person.\" class=\"dict\" href=\"patient-definitions.html#Patient.contact.address\"><b>address</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Address\">Address</a></span> <span style=\"color: navy\">Address for the contact person</span><span style=\"color: Gray\"> --></span></address>\r\n <<a title=\"Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.\" class=\"dict\" href=\"patient-definitions.html#Patient.contact.gender\"><b>gender</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administrative-gender.html\">Gender for administrative purposes</a></span><span style=\"color: Gray\"> --></span></gender>\r\n <<a title=\"Organization on behalf of which the contact is acting or for which the contact is working.\" class=\"dict\" href=\"patient-definitions.html#Patient.contact.organization\"><b>organization</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: SHALL at least contain a contact's details or a reference to an organization\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">\r\n Organization that is associated with the contact</span><span style=\"color: Gray\"> --></span></organization>\r\n </contact>\r\n <<a title=\"This element has a value if the patient is an animal (this element modifies the meaning of other elements)\" class=\"dict\" href=\"patient-definitions.html#Patient.animal\"><span style=\"text-decoration: underline\"><b>animal</b></span></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> If this patient is an animal (non-human)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span> --></span>\r\n <<a title=\"Identifies the high level categorization of the kind of animal.\" class=\"dict\" href=\"patient-definitions.html#Patient.animal.species\"><b>species</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-animal-species.html\">E.g. Dog, Cow<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></species>\r\n <<a title=\"Identifies the detailed categorization of the kind of animal.\" class=\"dict\" href=\"patient-definitions.html#Patient.animal.breed\"><b>breed</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-animal-breeds.html\">E.g. Poodle, Angus<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></breed>\r\n <<a title=\"Indicates the current state of the animal's reproductive organs.\" class=\"dict\" href=\"patient-definitions.html#Patient.animal.genderStatus\"><b>genderStatus</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-animal-genderstatus.html\">E.g. Neutered, Intact<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></genderStatus>\r\n </animal>\r\n <<a title=\"Languages which may be used to communicate with the patient about his or her health.\" class=\"dict\" href=\"patient-definitions.html#Patient.communication\"><b>communication</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://tools.ietf.org/html/bcp47.html\">Languages which may be used to communicate with the patient about his or her health</a></span><span style=\"color: Gray\"> --></span></communication>\r\n <<a title=\"Patient's nominated care provider.\" class=\"dict\" href=\"patient-definitions.html#Patient.careProvider\"><b>careProvider</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>|<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">\r\n Patient's nominated care provider</span><span style=\"color: Gray\"> --></span></careProvider>\r\n <<a title=\"Organization that is the custodian of the patient record.\" class=\"dict\" href=\"patient-definitions.html#Patient.managingOrganization\"><b>managingOrganization</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">\r\n Organization that is the custodian of the patient record<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></managingOrganization>\r\n <<a title=\"Link to another patient resource that concerns the same actual person (this element modifies the meaning of other elements)\" class=\"dict\" href=\"patient-definitions.html#Patient.link\"><span style=\"text-decoration: underline\"><b>link</b></span></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Link to another patient resource that concerns the same actual person<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span> --></span>\r\n <<a title=\"The other patient resource that the link refers to (this element modifies the meaning of other elements)\" class=\"dict\" href=\"patient-definitions.html#Patient.link.other\"><span style=\"text-decoration: underline\"><b>other</b></span></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">The other patient resource that the link refers to<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></other>\r\n <<a title=\"The type of link between this patient resource and another patient resource (this element modifies the meaning of other elements)\" class=\"dict\" href=\"patient-definitions.html#Patient.link.type\"><span style=\"text-decoration: underline\"><b>type</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"link-type.html\">replace | refer | seealso - type of link<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span>\r\n </link>\r\n <<a title=\"Whether this patient record is in active use (this element modifies the meaning of other elements)\" class=\"dict\" href=\"patient-definitions.html#Patient.active\"><span style=\"text-decoration: underline\"><b>active</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Whether this patient's record is in active use<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n</Patient>\r\n</pre></div>"
},
{
"title": "\"practitioner\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/practitioner",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/practitioner.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"A person who is directly or indirectly involved in the provisioning of healthcare.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner\"><b>Practitioner</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"An identifier that applies to this person in this role.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">A identifier for the person as this agent<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"A name associated with the person.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.name\"><b>name</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#HumanName\">HumanName</a></span> <span style=\"color: navy\">A name associated with the person<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></name>\r\n <<a title=\"A contact detail for the practitioner, e.g. a telephone number or an email address.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.telecom\"><b>telecom</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">A contact detail for the practitioner<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></telecom>\r\n <<a title=\"The postal address where the practitioner can be found or visited or to which mail can be delivered.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.address\"><b>address</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Address\">Address</a></span> <span style=\"color: navy\">Where practitioner can be found/visited<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></address>\r\n <<a title=\"Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.gender\"><b>gender</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administrative-gender.html\">Gender for administrative purposes<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></gender>\r\n <<a title=\"The date and time of birth for the practitioner.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.birthDate\"><b>birthDate</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">The date and time of birth for the practitioner<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Image of the person.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.photo\"><b>photo</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Attachment\">Attachment</a></span> <span style=\"color: navy\">Image of the person</span><span style=\"color: Gray\"> --></span></photo>\r\n <<a title=\"The organization that the practitioner represents.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.organization\"><b>organization</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">The represented organization<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></organization>\r\n <<a title=\"Roles which this practitioner is authorized to perform for the organization.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.role\"><b>role</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-practitioner-role.html\">Roles which this practitioner may perform<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></role>\r\n <<a title=\"Specific specialty of the practitioner.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.specialty\"><b>specialty</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-practitioner-specialty.html\">Specific specialty of the practitioner<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></specialty>\r\n <<a title=\"The period during which the person is authorized to act as a practitioner in these role(s) for the organization.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.period\"><b>period</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">\r\n The period during which the practitioner is authorized to perform in these role(s)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></period>\r\n <<a title=\"The location(s) at which this practitioner provides care.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.location\"><b>location</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">\r\n The location(s) at which this practitioner provides care</span><span style=\"color: Gray\"> --></span></location>\r\n <<a title=\"Qualifications obtained by training and certification.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.qualification\"><b>qualification</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Qualifications obtained by training and certification --></span>\r\n <<a title=\"Coded representation of the qualification.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.qualification.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-anzsco-occupations.html\">Coded representation of the qualification</a></span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"Period during which the qualification is valid.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.qualification.period\"><b>period</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">Period during which the qualification is valid</span><span style=\"color: Gray\"> --></span></period>\r\n <<a title=\"Organization that regulates and issues the qualification.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.qualification.issuer\"><b>issuer</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">\r\n Organization that regulates and issues the qualification</span><span style=\"color: Gray\"> --></span></issuer>\r\n </qualification>\r\n <<a title=\"A language the practitioner is able to use in patient communication.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.communication\"><b>communication</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://tools.ietf.org/html/bcp47.html\">A language the practitioner is able to use in patient communication</a></span><span style=\"color: Gray\"> --></span></communication>\r\n</Practitioner>\r\n</pre></div>"
},
"name": "practitioner",
"publisher": "FHIR Project",
"description": "Basic Profile. A person who is directly or indirectly involved in the provisioning of healthcare.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage Practitioner covers all individuals who are engaged in the healthcare process and healthcare-related services as part of their formal responsibilities and this Resource is used for attribution of activities and responsibilities to these individuals. Practitioners include (but are not limited to): \r\n\r\n* physicians, dentists, pharmacists\r\n* physician assistants, nurses, scribes\r\n* midwives, dietitians, therapists, optometrists, paramedics\r\n* medical technicians, laboratory scientists, prosthetic technicians, radiographers\r\n* social workers, professional home carers, official volunteers\r\n* receptionists handling patient registration\r\n* IT personnel merging or unmerging patient records",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
},
{
"identity": "servd",
"uri": "http://www.omg.org/spec/ServD/1.0/",
"name": "ServD"
}
],
"structure": [
{
"type": "Practitioner",
"publish": true,
"element": [
{
"path": "Practitioner",
"definition": {
"short": "A person with a formal responsibility in the provisioning of healthcare or related services",
"formal": "A person who is directly or indirectly involved in the provisioning of healthcare.",
"comments": "Note that a cab driver no longer fits the bill. You probably would be interested in the organization rather than the individual?.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Role"
},
{
"identity": "v2",
"map": "PRD (as one example)"
},
{
"identity": "servd",
"map": "Provider"
}
]
}
},
{
"path": "Practitioner.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Practitioner.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Practitioner.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "Practitioner.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "Practitioner.identifier",
"definition": {
"short": "A identifier for the person as this agent",
"formal": "An identifier that applies to this person in this role.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./id"
},
{
"identity": "v2",
"map": "PRD-7 (or XCN.1 Person Identifier)"
},
{
"identity": "servd",
"map": "./Identifiers"
}
]
}
},
{
"path": "Practitioner.name",
"definition": {
"short": "A name associated with the person",
"formal": "A name associated with the person.",
"min": 0,
"max": "1",
"type": [
{
"code": "HumanName"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./name"
},
{
"identity": "v2",
"map": "XCN Components"
},
{
"identity": "servd",
"map": "./PreferredName (GivenNames, FamilyName, TitleCode)"
}
]
}
},
{
"path": "Practitioner.telecom",
"definition": {
"short": "A contact detail for the practitioner",
"formal": "A contact detail for the practitioner, e.g. a telephone number or an email address.",
"comments": "Person may have multiple ways to be contacted with different uses or applicable periods. \rMay need to have options for contacting the person urgently, and also to help with identification.",
"min": 0,
"max": "*",
"type": [
{
"code": "Contact"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./telecom"
},
{
"identity": "v2",
"map": "PRT-15, STF-10, ROL-12"
},
{
"identity": "servd",
"map": "./ContactPoints"
}
]
}
},
{
"path": "Practitioner.address",
"definition": {
"short": "Where practitioner can be found/visited",
"formal": "The postal address where the practitioner can be found or visited or to which mail can be delivered.",
"min": 0,
"max": "1",
"type": [
{
"code": "Address"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./addr"
},
{
"identity": "v2",
"map": "ORC-24, STF-11, ROL-11, PRT-14"
},
{
"identity": "servd",
"map": "./Addresses"
}
]
}
},
{
"path": "Practitioner.gender",
"definition": {
"short": "Gender for administrative purposes",
"formal": "Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "AdministrativeGender",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/administrative-gender"
}
},
"mapping": [
{
"identity": "rim",
"map": "./administrativeGender"
},
{
"identity": "v2",
"map": "STF-5"
},
{
"identity": "servd",
"map": "./GenderCode"
}
]
}
},
{
"path": "Practitioner.birthDate",
"definition": {
"short": "The date and time of birth for the practitioner",
"formal": "The date and time of birth for the practitioner.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./birthTime"
},
{
"identity": "v2",
"map": "STF-6"
},
{
"identity": "servd",
"map": "(not represented in ServD)"
}
]
}
},
{
"path": "Practitioner.photo",
"definition": {
"short": "Image of the person",
"formal": "Image of the person.",
"min": 0,
"max": "*",
"type": [
{
"code": "Attachment"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./subjectOf/ObservationEvent[code=\"photo\"]/value"
},
{
"identity": "servd",
"map": "./ImageURI (only supports the URI reference)"
}
]
}
},
{
"path": "Practitioner.organization",
"definition": {
"short": "The represented organization",
"formal": "The organization that the practitioner represents.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./scoper"
},
{
"identity": "v2",
"map": "PRD-10 (-> 14) / PRA-9-Institution / PRT-8-Participation Organization for person participation"
},
{
"identity": "servd",
"map": "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)"
}
]
}
},
{
"path": "Practitioner.role",
"definition": {
"short": "Roles which this practitioner may perform",
"formal": "Roles which this practitioner is authorized to perform for the organization.",
"comments": "A person may have more than one role. At least one role is required.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "PractitionerRole",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/practitioner-role"
}
},
"mapping": [
{
"identity": "rim",
"map": "./code"
},
{
"identity": "v2",
"map": "PRD-1 / STF-18-job title / PRA-3-practitioner category / PRT-4-Participation / ROL-3-role-ROL / ORC-12-ordering provider / OBR-16-ordering provider / PV1-7-attending doctor / PV1-8-referring doctor / PV1-9-consulting doctor / PV1-17-admitting doctor"
},
{
"identity": "servd",
"map": "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)"
}
]
}
},
{
"path": "Practitioner.specialty",
"definition": {
"short": "Specific specialty of the practitioner",
"formal": "Specific specialty of the practitioner.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "PractitionerSpecialty",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/practitioner-specialty"
}
},
"mapping": [
{
"identity": "rim",
"map": "indirectAuthority/QualifiedEntity[code < Speciality]/code"
},
{
"identity": "v2",
"map": "PRA-5-specialty"
},
{
"identity": "servd",
"map": "./Specialty"
}
]
}
},
{
"path": "Practitioner.period",
"definition": {
"short": "The period during which the practitioner is authorized to perform in these role(s)",
"formal": "The period during which the person is authorized to act as a practitioner in these role(s) for the organization.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./effectiveTime"
},
{
"identity": "v2",
"map": "PRD-8/9 / PRA-5.4-date of certification"
},
{
"identity": "servd",
"map": "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)"
}
]
}
},
{
"path": "Practitioner.location",
"definition": {
"short": "The location(s) at which this practitioner provides care",
"formal": "The location(s) at which this practitioner provides care.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Location"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./target[classCode=\"indirectAuthority].source[classCode=SDLOC]"
},
{
"identity": "servd",
"map": "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)<br/>\nHowever these are accessed via the Site.ServiceSite.ServiceSiteProvider record. (The Site has the location)"
}
]
}
},
{
"path": "Practitioner.qualification",
"definition": {
"short": "Qualifications obtained by training and certification",
"formal": "Qualifications obtained by training and certification.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./indirectAuthority/QualifiedEntity[code < qualifiedEntity]"
},
{
"identity": "v2",
"map": "CER?"
},
{
"identity": "servd",
"map": "./Qualifications"
}
]
}
},
{
"path": "Practitioner.qualification.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Practitioner.qualification.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Practitioner.qualification.code",
"definition": {
"short": "Coded representation of the qualification",
"formal": "Coded representation of the qualification.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "Qualification",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/anzsco-occupations"
}
},
"mapping": [
{
"identity": "rim",
"map": "./code"
},
{
"identity": "servd",
"map": "./Qualifications.Value"
}
]
}
},
{
"path": "Practitioner.qualification.period",
"definition": {
"short": "Period during which the qualification is valid",
"formal": "Period during which the qualification is valid.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./effectiveTime"
},
{
"identity": "servd",
"map": "./Qualifications.StartDate and ./Qualifications.EndDate"
}
]
}
},
{
"path": "Practitioner.qualification.issuer",
"definition": {
"short": "Organization that regulates and issues the qualification",
"formal": "Organization that regulates and issues the qualification.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./scoper"
}
]
}
},
{
"path": "Practitioner.communication",
"definition": {
"short": "A language the practitioner is able to use in patient communication",
"formal": "A language the practitioner is able to use in patient communication.",
"comments": "The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "Language",
"isExtensible": false,
"conformance": "required",
"referenceUri": "http://tools.ietf.org/html/bcp47"
},
"mapping": [
{
"identity": "rim",
"map": "./languageCode"
},
{
"identity": "v2",
"map": "PID-15, NK1-20, LAN-2"
},
{
"identity": "servd",
"map": "./Languages.LanguageSpokenCode"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "address",
"type": "string",
"documentation": "An address in any kind of address/part",
"xpath": "f:Practitioner/f:address"
},
{
"name": "family",
"type": "string",
"documentation": "A portion of the family name",
"xpath": "f:Practitioner/f:name"
},
{
"name": "gender",
"type": "token",
"documentation": "Gender of the practitioner",
"xpath": "f:Practitioner/f:gender"
},
{
"name": "given",
"type": "string",
"documentation": "A portion of the given name",
"xpath": "f:Practitioner/f:name"
},
{
"name": "identifier",
"type": "token",
"documentation": "A practitioner's Identifier",
"xpath": "f:Practitioner/f:identifier"
},
{
"name": "name",
"type": "string",
"documentation": "A portion of either family or given name",
"xpath": "f:Practitioner/f:name"
},
{
"name": "organization",
"type": "reference",
"documentation": "The identity of the organization the practitioner represents / acts on behalf of",
"xpath": "f:Practitioner/f:organization"
},
{
"name": "phonetic",
"type": "string",
"documentation": "A portion of either family or given name using some kind of phonetic matching algorithm",
"xpath": "f:Practitioner/f:name"
},
{
"name": "telecom",
"type": "string",
"documentation": "The value in any kind of contact",
"xpath": "f:Practitioner/f:telecom"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"A person who is directly or indirectly involved in the provisioning of healthcare.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner\"><b>Practitioner</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"An identifier that applies to this person in this role.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">A identifier for the person as this agent<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"A name associated with the person.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.name\"><b>name</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#HumanName\">HumanName</a></span> <span style=\"color: navy\">A name associated with the person<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></name>\r\n <<a title=\"A contact detail for the practitioner, e.g. a telephone number or an email address.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.telecom\"><b>telecom</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">A contact detail for the practitioner<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></telecom>\r\n <<a title=\"The postal address where the practitioner can be found or visited or to which mail can be delivered.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.address\"><b>address</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Address\">Address</a></span> <span style=\"color: navy\">Where practitioner can be found/visited<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></address>\r\n <<a title=\"Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.gender\"><b>gender</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administrative-gender.html\">Gender for administrative purposes<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></gender>\r\n <<a title=\"The date and time of birth for the practitioner.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.birthDate\"><b>birthDate</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">The date and time of birth for the practitioner<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Image of the person.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.photo\"><b>photo</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Attachment\">Attachment</a></span> <span style=\"color: navy\">Image of the person</span><span style=\"color: Gray\"> --></span></photo>\r\n <<a title=\"The organization that the practitioner represents.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.organization\"><b>organization</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">The represented organization<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></organization>\r\n <<a title=\"Roles which this practitioner is authorized to perform for the organization.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.role\"><b>role</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-practitioner-role.html\">Roles which this practitioner may perform<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></role>\r\n <<a title=\"Specific specialty of the practitioner.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.specialty\"><b>specialty</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-practitioner-specialty.html\">Specific specialty of the practitioner<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></specialty>\r\n <<a title=\"The period during which the person is authorized to act as a practitioner in these role(s) for the organization.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.period\"><b>period</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">\r\n The period during which the practitioner is authorized to perform in these role(s)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></period>\r\n <<a title=\"The location(s) at which this practitioner provides care.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.location\"><b>location</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">\r\n The location(s) at which this practitioner provides care</span><span style=\"color: Gray\"> --></span></location>\r\n <<a title=\"Qualifications obtained by training and certification.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.qualification\"><b>qualification</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Qualifications obtained by training and certification --></span>\r\n <<a title=\"Coded representation of the qualification.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.qualification.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-anzsco-occupations.html\">Coded representation of the qualification</a></span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"Period during which the qualification is valid.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.qualification.period\"><b>period</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">Period during which the qualification is valid</span><span style=\"color: Gray\"> --></span></period>\r\n <<a title=\"Organization that regulates and issues the qualification.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.qualification.issuer\"><b>issuer</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">\r\n Organization that regulates and issues the qualification</span><span style=\"color: Gray\"> --></span></issuer>\r\n </qualification>\r\n <<a title=\"A language the practitioner is able to use in patient communication.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.communication\"><b>communication</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://tools.ietf.org/html/bcp47.html\">A language the practitioner is able to use in patient communication</a></span><span style=\"color: Gray\"> --></span></communication>\r\n</Practitioner>\r\n</pre></div>"
},
{
"title": "\"procedure\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/procedure",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/procedure.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"An action that is performed on a patient. This can be a physical 'thing' like an operation, or less invasive like counseling or hypnotherapy.\" class=\"dict\" href=\"procedure-definitions.html#Procedure\"><b>Procedure</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"This records identifiers associated with this procedure that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).\" class=\"dict\" href=\"procedure-definitions.html#Procedure.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">External Ids for this procedure<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"The person on whom the procedure was performed.\" class=\"dict\" href=\"procedure-definitions.html#Procedure.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Who procedure was performed on<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"The specific procedure that is performed. Use text if the exact nature of the procedure can't be coded.\" class=\"dict\" href=\"procedure-definitions.html#Procedure.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Identification of the procedure<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.\" class=\"dict\" href=\"procedure-definitions.html#Procedure.bodySite\"><b>bodySite</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Precise location details<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></bodySite>\r\n <<a title=\"The reason why the procedure was performed. This may be due to a Condition, may be coded entity of some type, or may simply be present as text.\" class=\"dict\" href=\"procedure-definitions.html#Procedure.indication\"><b>indication</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Reason procedure performed<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></indication>\r\n <<a title=\"Limited to 'real' people rather than equipment.\" class=\"dict\" href=\"procedure-definitions.html#Procedure.performer\"><b>performer</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> The people who performed the procedure<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span> --></span>\r\n <<a title=\"The practitioner who was involved in the procedure.\" class=\"dict\" href=\"procedure-definitions.html#Procedure.performer.person\"><b>person</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">The reference to the practitioner<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></person>\r\n <<a title=\"E.g. surgeon, anaethetist, endoscopist.\" class=\"dict\" href=\"procedure-definitions.html#Procedure.performer.role\"><b>role</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">The role the person was in<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></role>\r\n </performer>\r\n <<a title=\"The dates over which the procedure was performed. Allows a period to support complex procedures that span more that one date, and also allows for the length of the procedure to be captured.\" class=\"dict\" href=\"procedure-definitions.html#Procedure.date\"><b>date</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">The date the procedure was performed<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></date>\r\n <<a title=\"The encounter during which the procedure was performed.\" class=\"dict\" href=\"procedure-definitions.html#Procedure.encounter\"><b>encounter</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"encounter.html#Encounter\">Encounter</a>)</span> <span style=\"color: navy\">The encounter when procedure performed<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></encounter>\r\n <<a title=\"What was the outcome of the procedure - did it resolve reasons why the procedure was performed?.\" class=\"dict\" href=\"procedure-definitions.html#Procedure.outcome\"><b>outcome</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">What was result of procedure?<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"This could be a histology result. There could potentially be multiple reports - e.g. if this was a procedure that made multiple biopsies.\" class=\"dict\" href=\"procedure-definitions.html#Procedure.report\"><b>report</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"diagnosticreport.html#DiagnosticReport\">DiagnosticReport</a>)</span> <span style=\"color: navy\">Any report that results from the procedure</span><span style=\"color: Gray\"> --></span></report>\r\n <<a title=\"Any complications that occurred during the procedure, or in the immediate post-operative period. These are generally tracked separately from the notes, which typically will describe the procedure itself rather than any 'post procedure' issues.\" class=\"dict\" href=\"procedure-definitions.html#Procedure.complication\"><b>complication</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Complication following the procedure</span><span style=\"color: Gray\"> --></span></complication>\r\n <<a title=\"If the procedure required specific follow up - e.g. removal of sutures. The followup may be represented as a simple note, or potentially could be more complex in which case the CarePlan resource can be used.\" class=\"dict\" href=\"procedure-definitions.html#Procedure.followUp\"><b>followUp</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Instructions for follow up</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Procedures may be related to other items such as procedures or medications. For example treating wound dehiscence following a previous procedure.\" class=\"dict\" href=\"procedure-definitions.html#Procedure.relatedItem\"><b>relatedItem</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> A procedure that is related to this one --></span>\r\n <<a title=\"The nature of the relationship.\" class=\"dict\" href=\"procedure-definitions.html#Procedure.relatedItem.type\"><b>type</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"procedure-relationship-type.html\">caused-by | because-of</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The related item - e.g. a procedure.\" class=\"dict\" href=\"procedure-definitions.html#Procedure.relatedItem.target\"><b>target</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"adversereaction.html#AdverseReaction\">AdverseReaction</a>|<a href=\"allergyintolerance.html#AllergyIntolerance\">AllergyIntolerance</a>|<a href=\"careplan.html#CarePlan\">CarePlan</a>|\r\n <a href=\"condition.html#Condition\">Condition</a>|<a href=\"deviceobservationreport.html#DeviceObservationReport\">DeviceObservationReport</a>|<a href=\"diagnosticreport.html#DiagnosticReport\">DiagnosticReport</a>|<a href=\"familyhistory.html#FamilyHistory\">FamilyHistory</a>|\r\n <a href=\"imagingstudy.html#ImagingStudy\">ImagingStudy</a>|<a href=\"immunization.html#Immunization\">Immunization</a>|<a href=\"immunizationrecommendation.html#ImmunizationRecommendation\">ImmunizationRecommendation</a>|\r\n <a href=\"medicationadministration.html#MedicationAdministration\">MedicationAdministration</a>|<a href=\"medicationdispense.html#MedicationDispense\">MedicationDispense</a>|<a href=\"medicationprescription.html#MedicationPrescription\">MedicationPrescription</a>|\r\n <a href=\"medicationstatement.html#MedicationStatement\">MedicationStatement</a>|<a href=\"observation.html#Observation\">Observation</a>|<a href=\"procedure.html#Procedure\">Procedure</a>)</span> <span style=\"color: navy\">The related item - e.g. a procedure</span><span style=\"color: Gray\"> --></span></target>\r\n </relatedItem>\r\n <<a title=\"Any other notes about the procedure - e.g. the operative notes.\" class=\"dict\" href=\"procedure-definitions.html#Procedure.notes\"><b>notes</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Additional information about procedure</span><span style=\"color: Gray\"> --></span>\r\n</Procedure>\r\n</pre></div>"
},
"name": "procedure",
"publisher": "FHIR Project",
"description": "Basic Profile. An action that is performed on a patient. This can be a physical 'thing' like an operation, or less invasive like counseling or hypnotherapy.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage This resource is used to record the details of procedures performed on a patient. A procedure is an activity that is performed with or on a patient as part of the provision of care. Examples include surgical procedures, diagnostic procedures, endoscopic procedures, biopsies, and exclude things for which there are specific resources, such as immunizations, drug administrations. \r\n\r\nNote that many diagnostic processes are procedures that generate observations and reports. In many cases, the existence of the procedure is assumed, but where there are details of interest about how the diagnostic procedure was performed, the procedure resource is used to describe the activity.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "Procedure",
"publish": true,
"element": [
{
"path": "Procedure",
"definition": {
"short": "An action that is performed on a patient",
"formal": "An action that is performed on a patient. This can be a physical 'thing' like an operation, or less invasive like counseling or hypnotherapy.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Procedure[moodCode=EVN]"
}
]
}
},
{
"path": "Procedure.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Procedure.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Procedure.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "Procedure.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "Procedure.identifier",
"definition": {
"short": "External Ids for this procedure",
"formal": "This records identifiers associated with this procedure that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
}
},
{
"path": "Procedure.subject",
"definition": {
"short": "Who procedure was performed on",
"formal": "The person on whom the procedure was performed.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
}
]
}
},
{
"path": "Procedure.type",
"definition": {
"short": "Identification of the procedure",
"formal": "The specific procedure that is performed. Use text if the exact nature of the procedure can't be coded.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
}
},
{
"path": "Procedure.bodySite",
"definition": {
"short": "Precise location details",
"formal": "Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".approachSiteCode"
}
]
}
},
{
"path": "Procedure.indication",
"definition": {
"short": "Reason procedure performed",
"formal": "The reason why the procedure was performed. This may be due to a Condition, may be coded entity of some type, or may simply be present as text.",
"comments": "e.g. endoscopy for dilatation and biopsy, combination diagnosis and therapuetic.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".reasonCode"
}
]
}
},
{
"path": "Procedure.performer",
"definition": {
"short": "The people who performed the procedure",
"formal": "Limited to 'real' people rather than equipment.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PFM]"
}
]
}
},
{
"path": "Procedure.performer.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Procedure.performer.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Procedure.performer.person",
"definition": {
"short": "The reference to the practitioner",
"formal": "The practitioner who was involved in the procedure.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".role"
}
]
}
},
{
"path": "Procedure.performer.role",
"definition": {
"short": "The role the person was in",
"formal": "E.g. surgeon, anaethetist, endoscopist.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".functionCode"
}
]
}
},
{
"path": "Procedure.date",
"definition": {
"short": "The date the procedure was performed",
"formal": "The dates over which the procedure was performed. Allows a period to support complex procedures that span more that one date, and also allows for the length of the procedure to be captured.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "v2",
"map": "This should be choice of dateTime|Period"
}
]
}
},
{
"path": "Procedure.encounter",
"definition": {
"short": "The encounter when procedure performed",
"formal": "The encounter during which the procedure was performed.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Encounter"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"
}
]
}
},
{
"path": "Procedure.outcome",
"definition": {
"short": "What was result of procedure?",
"formal": "What was the outcome of the procedure - did it resolve reasons why the procedure was performed?.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=OUT].target.text"
}
]
}
},
{
"path": "Procedure.report",
"definition": {
"short": "Any report that results from the procedure",
"formal": "This could be a histology result. There could potentially be multiple reports - e.g. if this was a procedure that made multiple biopsies.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/DiagnosticReport"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN]"
}
]
}
},
{
"path": "Procedure.complication",
"definition": {
"short": "Complication following the procedure",
"formal": "Any complications that occurred during the procedure, or in the immediate post-operative period. These are generally tracked separately from the notes, which typically will describe the procedure itself rather than any 'post procedure' issues.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Need specialization of OUT for this."
}
]
}
},
{
"path": "Procedure.followUp",
"definition": {
"short": "Instructions for follow up",
"formal": "If the procedure required specific follow up - e.g. removal of sutures. The followup may be represented as a simple note, or potentially could be more complex in which case the CarePlan resource can be used.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=ACT, moodCode=INT].text"
}
]
}
},
{
"path": "Procedure.relatedItem",
"definition": {
"short": "A procedure that is related to this one",
"formal": "Procedures may be related to other items such as procedures or medications. For example treating wound dehiscence following a previous procedure.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=TRIG and target[classCode=PROC, moodCode=EVN]]"
}
]
}
},
{
"path": "Procedure.relatedItem.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Procedure.relatedItem.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Procedure.relatedItem.type",
"definition": {
"short": "caused-by | because-of",
"formal": "The nature of the relationship.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "ProcedureRelationshipType",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/procedure-relationship-type"
}
},
"mapping": [
{
"identity": "rim",
"map": ".inversionInd"
}
]
}
},
{
"path": "Procedure.relatedItem.target",
"definition": {
"short": "The related item - e.g. a procedure",
"formal": "The related item - e.g. a procedure.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/AdverseReaction"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/AllergyIntolerance"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/CarePlan"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Condition"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/DeviceObservationReport"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/DiagnosticReport"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/FamilyHistory"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/ImagingStudy"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Immunization"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/ImmunizationRecommendation"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/MedicationAdministration"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/MedicationDispense"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/MedicationPrescription"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/MedicationStatement"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Observation"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Procedure"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".target"
}
]
}
},
{
"path": "Procedure.notes",
"definition": {
"short": "Additional information about procedure",
"formal": "Any other notes about the procedure - e.g. the operative notes.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "date",
"type": "date",
"documentation": "The date the procedure was performed on",
"xpath": "f:Procedure/f:date"
},
{
"name": "subject",
"type": "reference",
"documentation": "The identity of a patient to list procedures for",
"xpath": "f:Procedure/f:subject"
},
{
"name": "type",
"type": "token",
"documentation": "Type of procedure",
"xpath": "f:Procedure/f:type"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"An action that is performed on a patient. This can be a physical 'thing' like an operation, or less invasive like counseling or hypnotherapy.\" class=\"dict\" href=\"procedure-definitions.html#Procedure\"><b>Procedure</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"This records identifiers associated with this procedure that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).\" class=\"dict\" href=\"procedure-definitions.html#Procedure.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">External Ids for this procedure<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"The person on whom the procedure was performed.\" class=\"dict\" href=\"procedure-definitions.html#Procedure.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Who procedure was performed on<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"The specific procedure that is performed. Use text if the exact nature of the procedure can't be coded.\" class=\"dict\" href=\"procedure-definitions.html#Procedure.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Identification of the procedure<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.\" class=\"dict\" href=\"procedure-definitions.html#Procedure.bodySite\"><b>bodySite</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Precise location details<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></bodySite>\r\n <<a title=\"The reason why the procedure was performed. This may be due to a Condition, may be coded entity of some type, or may simply be present as text.\" class=\"dict\" href=\"procedure-definitions.html#Procedure.indication\"><b>indication</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Reason procedure performed<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></indication>\r\n <<a title=\"Limited to 'real' people rather than equipment.\" class=\"dict\" href=\"procedure-definitions.html#Procedure.performer\"><b>performer</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> The people who performed the procedure<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span> --></span>\r\n <<a title=\"The practitioner who was involved in the procedure.\" class=\"dict\" href=\"procedure-definitions.html#Procedure.performer.person\"><b>person</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">The reference to the practitioner<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></person>\r\n <<a title=\"E.g. surgeon, anaethetist, endoscopist.\" class=\"dict\" href=\"procedure-definitions.html#Procedure.performer.role\"><b>role</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">The role the person was in<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></role>\r\n </performer>\r\n <<a title=\"The dates over which the procedure was performed. Allows a period to support complex procedures that span more that one date, and also allows for the length of the procedure to be captured.\" class=\"dict\" href=\"procedure-definitions.html#Procedure.date\"><b>date</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">The date the procedure was performed<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></date>\r\n <<a title=\"The encounter during which the procedure was performed.\" class=\"dict\" href=\"procedure-definitions.html#Procedure.encounter\"><b>encounter</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"encounter.html#Encounter\">Encounter</a>)</span> <span style=\"color: navy\">The encounter when procedure performed<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></encounter>\r\n <<a title=\"What was the outcome of the procedure - did it resolve reasons why the procedure was performed?.\" class=\"dict\" href=\"procedure-definitions.html#Procedure.outcome\"><b>outcome</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">What was result of procedure?<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"This could be a histology result. There could potentially be multiple reports - e.g. if this was a procedure that made multiple biopsies.\" class=\"dict\" href=\"procedure-definitions.html#Procedure.report\"><b>report</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"diagnosticreport.html#DiagnosticReport\">DiagnosticReport</a>)</span> <span style=\"color: navy\">Any report that results from the procedure</span><span style=\"color: Gray\"> --></span></report>\r\n <<a title=\"Any complications that occurred during the procedure, or in the immediate post-operative period. These are generally tracked separately from the notes, which typically will describe the procedure itself rather than any 'post procedure' issues.\" class=\"dict\" href=\"procedure-definitions.html#Procedure.complication\"><b>complication</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Complication following the procedure</span><span style=\"color: Gray\"> --></span></complication>\r\n <<a title=\"If the procedure required specific follow up - e.g. removal of sutures. The followup may be represented as a simple note, or potentially could be more complex in which case the CarePlan resource can be used.\" class=\"dict\" href=\"procedure-definitions.html#Procedure.followUp\"><b>followUp</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Instructions for follow up</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Procedures may be related to other items such as procedures or medications. For example treating wound dehiscence following a previous procedure.\" class=\"dict\" href=\"procedure-definitions.html#Procedure.relatedItem\"><b>relatedItem</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> A procedure that is related to this one --></span>\r\n <<a title=\"The nature of the relationship.\" class=\"dict\" href=\"procedure-definitions.html#Procedure.relatedItem.type\"><b>type</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"procedure-relationship-type.html\">caused-by | because-of</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The related item - e.g. a procedure.\" class=\"dict\" href=\"procedure-definitions.html#Procedure.relatedItem.target\"><b>target</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"adversereaction.html#AdverseReaction\">AdverseReaction</a>|<a href=\"allergyintolerance.html#AllergyIntolerance\">AllergyIntolerance</a>|<a href=\"careplan.html#CarePlan\">CarePlan</a>|\r\n <a href=\"condition.html#Condition\">Condition</a>|<a href=\"deviceobservationreport.html#DeviceObservationReport\">DeviceObservationReport</a>|<a href=\"diagnosticreport.html#DiagnosticReport\">DiagnosticReport</a>|<a href=\"familyhistory.html#FamilyHistory\">FamilyHistory</a>|\r\n <a href=\"imagingstudy.html#ImagingStudy\">ImagingStudy</a>|<a href=\"immunization.html#Immunization\">Immunization</a>|<a href=\"immunizationrecommendation.html#ImmunizationRecommendation\">ImmunizationRecommendation</a>|\r\n <a href=\"medicationadministration.html#MedicationAdministration\">MedicationAdministration</a>|<a href=\"medicationdispense.html#MedicationDispense\">MedicationDispense</a>|<a href=\"medicationprescription.html#MedicationPrescription\">MedicationPrescription</a>|\r\n <a href=\"medicationstatement.html#MedicationStatement\">MedicationStatement</a>|<a href=\"observation.html#Observation\">Observation</a>|<a href=\"procedure.html#Procedure\">Procedure</a>)</span> <span style=\"color: navy\">The related item - e.g. a procedure</span><span style=\"color: Gray\"> --></span></target>\r\n </relatedItem>\r\n <<a title=\"Any other notes about the procedure - e.g. the operative notes.\" class=\"dict\" href=\"procedure-definitions.html#Procedure.notes\"><b>notes</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Additional information about procedure</span><span style=\"color: Gray\"> --></span>\r\n</Procedure>\r\n</pre></div>"
},
{
"title": "\"profile\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/profile",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/profile.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"A Resource Profile - a statement of use of one or more FHIR Resources. It may include constraints on Resources and Data Types, Terminology Binding Statements and Extension Definitions.\" class=\"dict\" href=\"profile-definitions.html#Profile\"><b>Profile</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"The identifier that is used to identify this profile when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI).\" class=\"dict\" href=\"profile-definitions.html#Profile.identifier\"><b>identifier</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Logical id to reference this profile<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The identifier that is used to identify this version of the profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.\" class=\"dict\" href=\"profile-definitions.html#Profile.version\"><b>version</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Logical id for this version of the profile<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A free text natural language name identifying the Profile.\" class=\"dict\" href=\"profile-definitions.html#Profile.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Informal name for this profile<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Details of the individual or organization who accepts responsibility for publishing the profile.\" class=\"dict\" href=\"profile-definitions.html#Profile.publisher\"><b>publisher</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Name of the publisher (Organization or individual)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Contact details to assist a user in finding and communicating with the publisher.\" class=\"dict\" href=\"profile-definitions.html#Profile.telecom\"><b>telecom</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">Contact information of the publisher<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></telecom>\r\n <<a title=\"A free text natural language description of the profile and its use.\" class=\"dict\" href=\"profile-definitions.html#Profile.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Natural language description of the profile<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A set of terms from external terminologies that may be used to assist with indexing and searching of templates.\" class=\"dict\" href=\"profile-definitions.html#Profile.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Coding\">Coding</a></span> <span style=\"color: navy\">Assist with indexing and finding<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"The status of the profile (this element modifies the meaning of other elements)\" class=\"dict\" href=\"profile-definitions.html#Profile.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"resource-profile-status.html\">draft | active | retired<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.\" class=\"dict\" href=\"profile-definitions.html#Profile.experimental\"><b>experimental</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">If for testing purposes, not real usage<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The date that this version of the profile was published.\" class=\"dict\" href=\"profile-definitions.html#Profile.date\"><b>date</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Date for this version of the profile<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The Scope and Usage that this profile was created to meet.\" class=\"dict\" href=\"profile-definitions.html#Profile.requirements\"><b>requirements</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Scope and Usage this profile is for</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The version of the FHIR specification on which this profile is based.\" class=\"dict\" href=\"profile-definitions.html#Profile.fhirVersion\"><b>fhirVersion</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#id\">id</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">FHIR Version this profile targets<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"An external specification that the content is mapped to.\" class=\"dict\" href=\"profile-definitions.html#Profile.mapping\"><b>mapping</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> External specification that the content is mapped to --></span>\r\n <<a title=\"An Internal id that is used to identify this mapping set when specific mappings are made.\" class=\"dict\" href=\"profile-definitions.html#Profile.mapping.identity\"><b>identity</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#id\">id</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Internal id when this mapping is used</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A URI that identifies the specification that this mapping is expressed to.\" class=\"dict\" href=\"profile-definitions.html#Profile.mapping.uri\"><b>uri</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-26: Must have at a name or a uri (or both)\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Identifies what this mapping refers to</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A name for the specification that is being mapped to.\" class=\"dict\" href=\"profile-definitions.html#Profile.mapping.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-26: Must have at a name or a uri (or both)\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Names what this mapping refers to</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage.\" class=\"dict\" href=\"profile-definitions.html#Profile.mapping.comments\"><b>comments</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Versions, Issues, Scope limitations etc</span><span style=\"color: Gray\"> --></span>\r\n </mapping>\r\n <<a title=\"A constraint statement about what contents a resource or data type may have.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure\"><b>structure</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-8: SHALL define at least one structure constraint or extension definition\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> A constraint on a resource or a data type --></span>\r\n <<a title=\"The Resource or Data type being described.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.type\"><b>type</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-12: Only complex types can be constrained, not primitive types such as string etc.\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"defined-types.html\">The Resource or Data Type being described</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The name of this resource constraint statement (to refer to it from other resource constraints - from Profile.structure.element.definition.type.profile).\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Name for this particular structure (reference target)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"This definition of a profile on a structure is published as a formal statement. Some structural definitions might be defined purely for internal use within the profile, and not intended to be used outside that context.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.publish\"><b>publish</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">This definition is published (i.e. for validation)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Human summary: why describe this resource?.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.purpose\"><b>purpose</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Human summary: why describe this resource?</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Captures constraints on each element within the resource.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element\"><b>element</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Definition of elements in the resource (if no profile) --></span>\r\n <<a title=\"The path identifies the element and is expressed as a "."-separated list of ancestor elements, beginning with the name of the resource.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.path\"><b>path</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">The path of the element (see the formal definitions)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Codes that define how this element is represented in instances, when the deviation varies from the normal case.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.representation\"><b>representation</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"property-representation.html\">How this element is represented in instances</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The name of this element definition (to refer to it from other element definitions using Profile.structure.element.definition.nameReference). This is a unique name referring to a specific set of constraints applied to this element. One use of this is to provide a name to different slices of the same element.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Name for this particular element definition (reference target)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Indicates that the element is sliced into a set of alternative definitions (there are multiple definitions on a single element in the base resource). The set of slices is any elements that come after this in the element sequence that have the same path, until a shorter path occurs (the shorter path terminates the set).\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.slicing\"><b>slicing</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> This element is sliced - slices follow --></span>\r\n <<a title=\"Designates which child element is used to discriminate between the slices when processing an instance. The value of the child element in the instance SHALL completely distinguish which slice the element in the resource matches based on the allowed values for that element in each of the slices.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.slicing.discriminator\"><b>discriminator</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#id\">id</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Element that used to distinguish the slices</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"If the matching elements have to occur in the same order as defined in the profile.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.slicing.ordered\"><b>ordered</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">If elements must be in same order as slices</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Whether additional slices are allowed or not. When the slices are ordered, profile authors can also say that additional slices are only allowed at the end.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.slicing.rules\"><b>rules</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"resource-slicing-rules.html\">closed | open | openAtEnd</a></span><span style=\"color: Gray\"> --></span>\r\n </slicing>\r\n <<a title=\"Definition of the content of the element to provide a more specific definition than that contained for the element in the base resource.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition\"><b>definition</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> More specific definition of the element --></span>\r\n <<a title=\"A concise definition that is shown in the generated XML format that summarizes profiles (used throughout the specification).\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.short\"><b>short</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Concise definition for xml presentation</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The definition SHALL be consistent with the base definition, but convey the meaning of the element in the particular context of use of the resource.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.formal\"><b>formal</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Full formal definition in human language</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Comments about the use of the element, including notes about how to use the data properly, exceptions to proper use, etc.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.comments\"><b>comments</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Comments about the use of this element</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Explains why this element is needed and why it's been constrained as it has.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.requirements\"><b>requirements</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Why is this needed?</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identifies additional names by which this element might also be known.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.synonym\"><b>synonym</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: navy\">Other names</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The minimum number of times this element SHALL appear in the instance.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.min\"><b>min</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Minimum Cardinality</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The maximum number of times this element is permitted to appear in the instance.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.max\"><b>max</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-6: Max SHALL be a number or "*"\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 1..1</b></span> <span style=\"color: navy\">Maximum Cardinality (a number or *)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The data type or resource that the value of this element is permitted to be.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.type\"><b>type</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Data type and Profile for this element --></span>\r\n <<a title=\"Name of Data type or Resource.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.type.code\"><b>code</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"data-types.html\">Name of Data type or Resource</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identifies a profile that SHALL hold for resources or datatypes referenced as the type of this element. Can be a local reference - to another structure in this profile, or a reference to a structure in another profile.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.type.profile\"><b>profile</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-8: SHALL define at least one structure constraint or extension definition\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Profile.structure to apply</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"If the type is a reference to another resource, how the resource is or can be aggreated - is it a contained resource, or a reference, and if the context is a bundle, is it included in the bundle.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.type.aggregation\"><b>aggregation</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-9: Aggregation may only be specified if one of the allowed types for the element is a resource\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"resource-aggregation-mode.html\">contained | referenced | bundled - how aggregated</a></span><span style=\"color: Gray\"> --></span>\r\n </type>\r\n <<a title=\"Identifies the name of a slice defined elsewhere in the profile whose constraints should be applied to the current element.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.nameReference\"><b>nameReference</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: Either a namereference or a fixed value (but not both) is permitted\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">To another element constraint (by element.name)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Specifies a primitive value that SHALL hold for this element in the instance.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.value_x_\"><b>value[x]</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: Either a namereference or a fixed value (but not both) is permitted; Inv-10: Value may only be specified if the type consists of a single repetition that has a type corresponding to one of the primitive data types.\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#open\">*</a></span> <span style=\"color: navy\">Fixed value: [as defined for a primitive type]</span><span style=\"color: Gray\"> --></span></value[x]>\r\n <<a title=\"An example value for this element.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.example_x_\"><b>example[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#open\">*</a></span> <span style=\"color: navy\">Example value: [as defined for type]</span><span style=\"color: Gray\"> --></span></example[x]>\r\n <<a title=\"Indicates the shortest length that SHALL be supported by conformant instances without truncation.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.maxLength\"><b>maxLength</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Length for strings</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A reference to an invariant that may make additional statements about the cardinality or value in the instance.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.condition\"><b>condition</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#id\">id</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: navy\">Reference to invariant about presence</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.constraint\"><b>constraint</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Condition that must evaluate to true --></span>\r\n <<a title=\"Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.constraint.key\"><b>key</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#id\">id</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Target of 'condition' reference above</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Used to label the constraint in OCL or in short displays incapable of displaying the full human description.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.constraint.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Short human label</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identifies the impact constraint violation has on the conformance of the instance.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.constraint.severity\"><b>severity</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"constraint-severity.html\">error | warning</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Text that can be used to describe the constraint in messages identifying that the constraint has been violated.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.constraint.human\"><b>human</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Human description of constraint</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"XPath expression of constraint.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.constraint.xpath\"><b>xpath</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">XPath expression of constraint</span><span style=\"color: Gray\"> --></span>\r\n </constraint>\r\n <<a title=\"If true, conformant resource authors SHALL be capable of providing a value for the element and resource consumers SHALL be capable of extracting and doing something useful with the data element. If false, the element may be ignored and not supported.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.mustSupport\"><b>mustSupport</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">If the element must supported</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"If true, the value of this element affects the interpretation of the element or resource that contains it, and the value of the element cannot be ignored. Typically, this is used for status, negation and qualification codes. The effect of this is that the element cannot be ignored by systems: they SHALL either recognize the element and process it, and/or a pre-determination has been made that it is not relevant to their particular system.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.isModifier\"><b>isModifier</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">If this modifies the meaning of other elements</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Binds to a value set if this element is coded (code, Coding, CodeableConcept).\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.binding\"><b>binding</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-12: Only complex types can be constrained, not primitive types such as string etc.\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> ValueSet details if this is coded --></span>\r\n <<a title=\"A descriptive name for this - can be useful for generating implementation artifacts.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.binding.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-11: Must have either a slice or a definition, but not both\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 1..1</b></span> <span style=\"color: navy\">Descriptive Name</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"If true, then conformant systems may use additional codes or (where the data type permits) text alone to convey concepts not covered by the set of codes identified in the binding. If false, then conformant systems are constrained to the provided codes alone.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.binding.isExtensible\"><b>isExtensible</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-14: Example value sets are always extensible\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 1..1</b></span> <span style=\"color: navy\">Can additional codes be used?</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Indicates the degree of conformance expectations associated with this binding.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.binding.conformance\"><b>conformance</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-14: Example value sets are always extensible\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"binding-conformance.html\">required | preferred | example</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Describes the intended use of this particular set of codes.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.binding.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-3: provide either a reference or a description (or both)\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Human explanation of the value set</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Points to the value set or external definition that identifies the set of codes to be used.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.binding.reference_x_\"><b>reference[x]</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-3: provide either a reference or a description (or both)\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a>|<a href=\"references.html#Resource\">Resource</a>(<a href=\"valueset.html#ValueSet\">ValueSet</a>)</span> <span style=\"color: navy\">Source of value set</span><span style=\"color: Gray\"> --></span></reference[x]>\r\n </binding>\r\n <<a title=\"Identifies a concept from an external specification that roughly corresponds to this element.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.mapping\"><b>mapping</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Map element to another set of definitions --></span>\r\n <<a title=\"An internal reference to the definition of a mapping.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.mapping.identity\"><b>identity</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#id\">id</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-26: Must have at a name or a uri (or both)\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 1..1</b></span> <span style=\"color: navy\">Reference to mapping declaration</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Expresses what part of the target specification corresponds to this element.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.mapping.map\"><b>map</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Details of the mapping</span><span style=\"color: Gray\"> --></span>\r\n </mapping>\r\n </definition>\r\n </element>\r\n <<a title=\"Additional search parameters for implementations to support and/or make use of.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.searchParam\"><b>searchParam</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Search params defined --></span>\r\n <<a title=\"The name of the standard or custom search parameter.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.searchParam.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Name of search parameter</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The type of value a search parameter refers to, and how the content is interpreted.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.searchParam.type\"><b>type</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"search-param-type.html\">number | date | string | token | reference | composite | quantity</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A specification for search parameters. For standard parameters, provides additional information on how the parameter is used in this solution. For custom parameters, provides a description of what the parameter does.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.searchParam.documentation\"><b>documentation</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Contents and meaning of search parameter</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"An XPath expression that returns a set of elements for the search parameter.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.searchParam.xpath\"><b>xpath</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">XPath that extracts the parameter set</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Types of resource (if a resource is referenced).\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.searchParam.target\"><b>target</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"resource-types.html\">Types of resource (if a resource reference)</a></span><span style=\"color: Gray\"> --></span>\r\n </searchParam>\r\n </structure>\r\n <<a title=\"An extension defined as part of the profile.\" class=\"dict\" href=\"profile-definitions.html#Profile.extensionDefn\"><b>extensionDefn</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-8: SHALL define at least one structure constraint or extension definition\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> Definition of an extension --></span>\r\n <<a title=\"A unique code (within the profile) used to identify the extension.\" class=\"dict\" href=\"profile-definitions.html#Profile.extensionDefn.code\"><b>code</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-5: Codes SHALL be unique in the context of a profile\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 1..1</b></span> <span style=\"color: navy\">Identifies the extension in this profile</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Defined so that applications can use this name when displaying the value of the extension to the user.\" class=\"dict\" href=\"profile-definitions.html#Profile.extensionDefn.display\"><b>display</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Use this name when displaying the value</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identifies the type of context to which the extension applies.\" class=\"dict\" href=\"profile-definitions.html#Profile.extensionDefn.contextType\"><b>contextType</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"extension-context.html\">resource | datatype | mapping | extension</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identifies the types of resource or data type elements to which the extension can be applied.\" class=\"dict\" href=\"profile-definitions.html#Profile.extensionDefn.context\"><b>context</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..*</b></span> <span style=\"color: navy\">Where the extension can be used in instances</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Definition of the extension and its content.\" class=\"dict\" href=\"profile-definitions.html#Profile.extensionDefn.definition\"><b>definition</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\">Content as for Profile.structure.element.definition</span> <span style=\"color: navy\">Definition of the extension and its content</span><span style=\"color: Gray\"> --></span></definition>\r\n </extensionDefn>\r\n <<a title=\"Definition of a named query and its parameters and their meaning.\" class=\"dict\" href=\"profile-definitions.html#Profile.query\"><b>query</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Definition of a named query --></span>\r\n <<a title=\"The name of a query, which is used in the URI from Conformance statements declaring use of the query. Typically this will also be the name for the _query parameter when the query is called, though in some cases it may be aliased by a server to avoid collisions.\" class=\"dict\" href=\"profile-definitions.html#Profile.query.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Special named queries (_query=)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Description of the query - the functionality it offers, and considerations about how it functions and to use it.\" class=\"dict\" href=\"profile-definitions.html#Profile.query.documentation\"><b>documentation</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Describes the named query</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A parameter of a named query.\" class=\"dict\" href=\"profile-definitions.html#Profile.query.parameter\"><b>parameter</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\">Content as for Profile.structure.searchParam</span> <span style=\"color: navy\">Parameter for the named query</span><span style=\"color: Gray\"> --></span></parameter>\r\n </query>\r\n</Profile>\r\n</pre></div>"
},
"name": "profile",
"publisher": "FHIR Project",
"description": "Basic Profile. A Resource Profile - a statement of use of one or more FHIR Resources. It may include constraints on Resources and Data Types, Terminology Binding Statements and Extension Definitions.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage This specification describes a set of base resources that are used in many different contexts in healthcare. In order to make this manageable, applications and specifications need to be able to describe restrictions on how one or more resource(s) are used, including defining extensions, and controlling how terminology is used. These descriptions need to be able to be shared through repositories of profile definitions, and need to allow for these usage statements to be published, compared, and used as the basis for code, report and UI generation. All these things are done using a \"Profile\", which itself is represented as a resource. \r\n\r\nProfile resources have three main parts: \r\n\r\n* A metadata section the describes the profile, and supports registry searching\r\n* Structures that define and describe how a Resource or Data Type is used\r\n* Extension Definitions that define extensions that can be used in structures\r\nThis page defines the profile resource, and describes how it is used. Note that as part of the specification itself, a full set of profiles for all resources and data types is published. \r\n\r\nA FHIR RESTful server serving the profile resource is also a profile repository. HL7 hosts one for public registration of FHIR profiles at (yet to be done).",
"structure": [
{
"type": "Profile",
"publish": true,
"element": [
{
"path": "Profile",
"definition": {
"short": "Resource Profile",
"formal": "A Resource Profile - a statement of use of one or more FHIR Resources. It may include constraints on Resources and Data Types, Terminology Binding Statements and Extension Definitions.",
"comments": "Often called a clinical template.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"constraint": [
{
"key": "17",
"severity": "error",
"human": "There can't be multiple structures with the same type and name",
"xpath": "not(exists(for $structure in f:structure return $structure/preceding-sibling::f:structure[f:type/@value=$structure/f:type/@value and f:name/@value = $structure/f:name/@value]))"
},
{
"key": "15",
"severity": "error",
"human": "Where multiple structures exist with the same type, they SHALL have names",
"xpath": "count(f:structure[not(f:name)]) = count(distinct-values(f:structure[not(f:name)]/f:type/@value))"
},
{
"key": "8",
"severity": "error",
"human": "SHALL define at least one structure constraint or extension definition",
"xpath": "exists(f:structure) or exists(f:extensionDefn)"
},
{
"key": "16",
"severity": "error",
"human": "Extension definition codes must be unique",
"xpath": "count(f:extensionDefn) = count(distinct-values(f:extensionDefn/f:code/@value))"
},
{
"key": "27",
"severity": "error",
"human": "Structure name must be unique",
"xpath": "count(distinct-values(f:structure/f:name/@value)) =count(f:structure/f:name)"
},
{
"key": "28",
"severity": "error",
"human": "Query name must be unique",
"xpath": "count(distinct-values(f:query/f:name/@value)) =count(f:query/f:name)"
}
],
"isModifier": false
}
},
{
"path": "Profile.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Profile.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Profile.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "Profile.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "Profile.identifier",
"definition": {
"short": "Logical id to reference this profile",
"formal": "The identifier that is used to identify this profile when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI).",
"comments": "N/A.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Profile.version",
"definition": {
"short": "Logical id for this version of the profile",
"formal": "The identifier that is used to identify this version of the profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.",
"comments": "N/A.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Profile.name",
"definition": {
"short": "Informal name for this profile",
"formal": "A free text natural language name identifying the Profile.",
"comments": "Not expected to be globally unique.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Profile.publisher",
"definition": {
"short": "Name of the publisher (Organization or individual)",
"formal": "Details of the individual or organization who accepts responsibility for publishing the profile.",
"comments": "Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Profile.telecom",
"definition": {
"short": "Contact information of the publisher",
"formal": "Contact details to assist a user in finding and communicating with the publisher.",
"comments": "May be a web site, an email address, a telephone number (tel:), etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "Contact"
}
],
"isModifier": false
}
},
{
"path": "Profile.description",
"definition": {
"short": "Natural language description of the profile",
"formal": "A free text natural language description of the profile and its use.",
"comments": "This field can be used for things such as why the profile was written, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is *not* a rendering of the profile as conveyed in Profile.text. This item SHOULD be populated unless the information is available from context.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Profile.code",
"definition": {
"short": "Assist with indexing and finding",
"formal": "A set of terms from external terminologies that may be used to assist with indexing and searching of templates.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"isModifier": false
}
},
{
"path": "Profile.status",
"definition": {
"short": "draft | active | retired",
"formal": "The status of the profile.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "ResourceProfileStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/resource-profile-status"
}
}
}
},
{
"path": "Profile.experimental",
"definition": {
"short": "If for testing purposes, not real usage",
"formal": "This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false
}
},
{
"path": "Profile.date",
"definition": {
"short": "Date for this version of the profile",
"formal": "The date that this version of the profile was published.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false
}
},
{
"path": "Profile.requirements",
"definition": {
"short": "Scope and Usage this profile is for",
"formal": "The Scope and Usage that this profile was created to meet.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Profile.fhirVersion",
"definition": {
"short": "FHIR Version this profile targets",
"formal": "The version of the FHIR specification on which this profile is based.",
"comments": "A profile does not need to specify the target it applies to,as profiles will often be valid across multiple versions of FHIR. FHIR tooling can determine whether a profile is consistent with a particular profile if desired.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"isModifier": false
}
},
{
"path": "Profile.mapping",
"definition": {
"short": "External specification that the content is mapped to",
"formal": "An external specification that the content is mapped to.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "26",
"severity": "error",
"human": "Must have at a name or a uri (or both)",
"xpath": "exists(f:uri) or exists(f:name)"
}
],
"isModifier": false
}
},
{
"path": "Profile.mapping.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Profile.mapping.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Profile.mapping.identity",
"definition": {
"short": "Internal id when this mapping is used",
"formal": "An Internal id that is used to identify this mapping set when specific mappings are made.",
"comments": "The specification is described once, with general comments, and then specific mappings are made that reference this declaration.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
],
"isModifier": false
}
},
{
"path": "Profile.mapping.uri",
"definition": {
"short": "Identifies what this mapping refers to",
"formal": "A URI that identifies the specification that this mapping is expressed to.",
"comments": "A formal identity for the specification being mapped to helps with identifying maps consistently.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false
}
},
{
"path": "Profile.mapping.name",
"definition": {
"short": "Names what this mapping refers to",
"formal": "A name for the specification that is being mapped to.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Profile.mapping.comments",
"definition": {
"short": "Versions, Issues, Scope limitations etc",
"formal": "Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure",
"definition": {
"short": "A constraint on a resource or a data type",
"formal": "A constraint statement about what contents a resource or data type may have.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "18",
"severity": "error",
"human": "Element paths must be unique - or not (LM)",
"xpath": "count(f:element) >= count(distinct-values(f:element/f:path/@value))"
},
{
"key": "29",
"severity": "error",
"human": "Parameter names must be unique within structure",
"xpath": "count(distinct-values(f:searchParam/f:name/@value)) =count(f:searchParam/f:name)"
},
{
"key": "12",
"severity": "error",
"human": "Only complex types can be constrained, not primitive types such as string etc.",
"xpath": "upper-case(substring(f:type,1,1))=substring(f:type,1,1)"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.type",
"definition": {
"short": "The Resource or Data Type being described",
"formal": "The Resource or Data type being described.",
"comments": "Only complex types can be constrained, not primitive types such as string etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "FHIRDefinedType",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/defined-types"
}
}
}
},
{
"path": "Profile.structure.name",
"definition": {
"short": "Name for this particular structure (reference target)",
"formal": "The name of this resource constraint statement (to refer to it from other resource constraints - from Profile.structure.element.definition.type.profile).",
"comments": "This field is the target for a resource.profile.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.publish",
"definition": {
"short": "This definition is published (i.e. for validation)",
"formal": "This definition of a profile on a structure is published as a formal statement. Some structural definitions might be defined purely for internal use within the profile, and not intended to be used outside that context.",
"comments": "If there is more than one published structure for each type, and the URL reference to the profile doesn't specify which named structure to use (using a URL fragment, e.g. #...) then which profile to use is indeterminate, and an error should be raised.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.purpose",
"definition": {
"short": "Human summary: why describe this resource?",
"formal": "Human summary: why describe this resource?.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element",
"definition": {
"short": "Definition of elements in the resource (if no profile)",
"formal": "Captures constraints on each element within the resource.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "21",
"severity": "error",
"human": "An element that's a slicing descriptor must not be preceded by an element that starts with the same path and must be followed by an element with exactly the same path.",
"xpath": "not(f:slicing) or (not(starts-with(preceding-sibling::f:element[1]/f:path/@value, current()/f:path/@value)) and following-sibling::f:element[1]/f:path/@value=current()/f:path/@value)"
},
{
"key": "20",
"severity": "error",
"human": "An element must either be a definition or a slicing descriptor, never both.",
"xpath": "exists(f:slicing)!=exists(f:definition)"
},
{
"key": "11",
"severity": "error",
"human": "Must have either a slice or a definition, but not both",
"xpath": "exists(f:slicing) != exists(f:definition)"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.path",
"definition": {
"short": "The path of the element (see the formal definitions)",
"formal": "The path identifies the element and is expressed as a \".\"-separated list of ancestor elements, beginning with the name of the resource.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.representation",
"definition": {
"short": "How this element is represented in instances",
"formal": "Codes that define how this element is represented in instances, when the deviation varies from the normal case.",
"comments": "This is rarely used except for special cases where the representation deviates from the norml, which is done only very reluctantly, and can only be done in the base standard (and profiles must reproduce what the base standard does.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "PropertyRepresentation",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/property-representation"
}
}
}
},
{
"path": "Profile.structure.element.name",
"definition": {
"short": "Name for this particular element definition (reference target)",
"formal": "The name of this element definition (to refer to it from other element definitions using Profile.structure.element.definition.nameReference). This is a unique name referring to a specific set of constraints applied to this element. One use of this is to provide a name to different slices of the same element.",
"comments": "The name SHALL be unique within the profile and all imported profiles within the context of the constrained resource element. (Though to avoid confusion, uniqueness across all elements is recommended.).",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.slicing",
"definition": {
"short": "This element is sliced - slices follow",
"formal": "Indicates that the element is sliced into a set of alternative definitions (there are multiple definitions on a single element in the base resource). The set of slices is any elements that come after this in the element sequence that have the same path, until a shorter path occurs (the shorter path terminates the set).",
"min": 0,
"max": "1",
"isModifier": false
}
},
{
"path": "Profile.structure.element.slicing.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.slicing.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.slicing.discriminator",
"definition": {
"short": "Element that used to distinguish the slices",
"formal": "Designates which child element is used to discriminate between the slices when processing an instance. The value of the child element in the instance SHALL completely distinguish which slice the element in the resource matches based on the allowed values for that element in each of the slices.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.slicing.ordered",
"definition": {
"short": "If elements must be in same order as slices",
"formal": "If the matching elements have to occur in the same order as defined in the profile.",
"comments": "Order should only be required when it is a pressing concern for presentation. Profile authors should consider making the order a feature of the rules about the narrative, not the rules about the data - requiring ordered data makes the profile much less re-usable.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.slicing.rules",
"definition": {
"short": "closed | open | openAtEnd",
"formal": "Whether additional slices are allowed or not. When the slices are ordered, profile authors can also say that additional slices are only allowed at the end.",
"comments": "Allowing additional elements makes for a much for flexible template - it's open for use in wider contexts, but also means that the content of the resource is not closed, and applications have to decide how to handle content not described by the profile.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "SlicingRules",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/resource-slicing-rules"
}
}
}
},
{
"path": "Profile.structure.element.definition",
"definition": {
"short": "More specific definition of the element",
"formal": "Definition of the content of the element to provide a more specific definition than that contained for the element in the base resource.",
"comments": "The definition SHALL be a proper constraint on the definition of the base resource.",
"min": 0,
"max": "1",
"constraint": [
{
"key": "2",
"severity": "error",
"human": "Either a namereference or a fixed value (but not both) is permitted",
"xpath": "not(exists(f:nameReference) and exists(f:*[starts-with(local-name(.), 'value')]))"
},
{
"key": "10",
"severity": "error",
"human": "Value may only be specified if the type consists of a single repetition that has a type corresponding to one of the primitive data types.",
"xpath": "not(exists(f:*[starts-with(local-name(.), 'value')])) or (count(f:type)=1 and f:type/f:code[substring(@value,1,1)=lower-case(substring(@value,1,1))])"
},
{
"key": "7",
"severity": "error",
"human": "Binding can only be present for coded elements",
"xpath": "not(exists(f:binding)) or f:type/f:code/@value=('code','Coding','CodeableConcept','Quantity')"
},
{
"key": "19",
"severity": "error",
"human": "Element names must be unique",
"xpath": "count(f:element[f:name]) = count(distinct-values(f:element/f:name/@value))"
},
{
"key": "22",
"severity": "error",
"human": "If a definition has multiple types with the same code, each must specify a profile",
"xpath": "count(f:type[not(f:profile)]) = count(distinct-values(f:type[not(f:profile)]/f:code/@value))"
},
{
"key": "23",
"severity": "error",
"human": "Types must be unique by the combination of code and profile",
"xpath": "not(exists(for $type in f:type return $type/preceding-sibling::f:type[f:code/@value=$type/f:code/@value and f:profile/@value = $type/f:profile/@value]))"
},
{
"key": "24",
"severity": "error",
"human": "Constraints must be unique by key",
"xpath": "count(f:constraint) = count(distinct-values(f:constraint/f:key/@value))"
},
{
"key": "25",
"severity": "error",
"human": "Constraint names must be unique.",
"xpath": "count(f:constraint[f:name]) = count(distinct-values(f:constraint/f:name/@value))"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.short",
"definition": {
"short": "Concise definition for xml presentation",
"formal": "A concise definition that is shown in the generated XML format that summarizes profiles (used throughout the specification).",
"comments": "May change the term to provide language more appropriate to the context of the profile or to reflect slicing.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.formal",
"definition": {
"short": "Full formal definition in human language",
"formal": "The definition SHALL be consistent with the base definition, but convey the meaning of the element in the particular context of use of the resource.",
"comments": "It is easy for a different definition to change the meaning of an element and this can have nasty downstream consequences. Please be careful when providing definitions.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.comments",
"definition": {
"short": "Comments about the use of this element",
"formal": "Comments about the use of the element, including notes about how to use the data properly, exceptions to proper use, etc.",
"comments": "If it is possible to capture usage rules using invariants, that mechanism should be used in preference to this element.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.requirements",
"definition": {
"short": "Why is this needed?",
"formal": "Explains why this element is needed and why it's been constrained as it has.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.synonym",
"definition": {
"short": "Other names",
"formal": "Identifies additional names by which this element might also be known.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.min",
"definition": {
"short": "Minimum Cardinality",
"formal": "The minimum number of times this element SHALL appear in the instance.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.max",
"definition": {
"short": "Maximum Cardinality (a number or *)",
"formal": "The maximum number of times this element is permitted to appear in the instance.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "6",
"severity": "error",
"human": "Max SHALL be a number or \"*\"",
"xpath": "@value='*' or (normalize-space(@value)!='' and normalize-space(translate(@value, '0123456789',''))='')"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.type",
"definition": {
"short": "Data type and Profile for this element",
"formal": "The data type or resource that the value of this element is permitted to be.",
"comments": "The Type of the element can be left blank, in which case the type is inherited from the resource. The type can only be listed in this field if it is an allowed option in the base resource.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "9",
"severity": "error",
"human": "Aggregation may only be specified if one of the allowed types for the element is a resource",
"xpath": "not(exists(f:aggregation)) or exists(f:code[starts-with(@value, 'Resource(')])"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.type.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.type.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.type.code",
"definition": {
"short": "Name of Data type or Resource",
"formal": "Name of Data type or Resource.",
"comments": "If the element is a reference to another resource, this element contains \"ResourceReference\", and the profile element refers to the profile of the allowed target of the resource, which may be a reference to the general definition of a resource (e.g. http://hl7.org/fhir/profiles/Patient). There would be one pair of type/code for each allowed target resource type.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "DataType",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/data-types"
}
}
}
},
{
"path": "Profile.structure.element.definition.type.profile",
"definition": {
"short": "Profile.structure to apply",
"formal": "Identifies a profile that SHALL hold for resources or datatypes referenced as the type of this element. Can be a local reference - to another structure in this profile, or a reference to a structure in another profile.",
"comments": "The reference might be a simple name in the form #[name], which is a reference to another named constraint in a resource - where the resource contains more than one constraint, or a URL which is a reference to a resource Profile, with a terminal #[name] which identifies a specific structure entry in the profile.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.type.aggregation",
"definition": {
"short": "contained | referenced | bundled - how aggregated",
"formal": "If the type is a reference to another resource, how the resource is or can be aggreated - is it a contained resource, or a reference, and if the context is a bundle, is it included in the bundle.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "AggregationMode",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/resource-aggregation-mode"
}
}
}
},
{
"path": "Profile.structure.element.definition.nameReference",
"definition": {
"short": "To another element constraint (by element.name)",
"formal": "Identifies the name of a slice defined elsewhere in the profile whose constraints should be applied to the current element.",
"comments": "If child components of this element are defined, they act as constraints on the referenced slice.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.value[x]",
"definition": {
"short": "Fixed value: [as defined for a primitive type]",
"formal": "Specifies a primitive value that SHALL hold for this element in the instance.",
"comments": "To specify a fixed value for a complex data type, include the child elements for the type and specify fixed values for each property independently.",
"min": 0,
"max": "1",
"type": [
{
"code": "*"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.example[x]",
"definition": {
"short": "Example value: [as defined for type]",
"formal": "An example value for this element.",
"comments": "If the example value are fully populated, the publication tool can generate an instance automatically.",
"min": 0,
"max": "1",
"type": [
{
"code": "*"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.maxLength",
"definition": {
"short": "Length for strings",
"formal": "Indicates the shortest length that SHALL be supported by conformant instances without truncation.",
"comments": "If not specified, there is no conformance expectation for length support.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.condition",
"definition": {
"short": "Reference to invariant about presence",
"formal": "A reference to an invariant that may make additional statements about the cardinality or value in the instance.",
"min": 0,
"max": "*",
"type": [
{
"code": "id"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.constraint",
"definition": {
"short": "Condition that must evaluate to true",
"formal": "Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance.",
"comments": "Constraints should be declared on the \"context\" element - the lowest element in the hierarchy that is common to all nodes referenced by the constraint.",
"min": 0,
"max": "*",
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.constraint.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.constraint.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.constraint.key",
"definition": {
"short": "Target of 'condition' reference above",
"formal": "Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.constraint.name",
"definition": {
"short": "Short human label",
"formal": "Used to label the constraint in OCL or in short displays incapable of displaying the full human description.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.constraint.severity",
"definition": {
"short": "error | warning",
"formal": "Identifies the impact constraint violation has on the conformance of the instance.",
"comments": "This allows constraints to be asserted as \"shall\" (error) and \"should\" (warning).",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "ConstraintSeverity",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/constraint-severity"
}
}
}
},
{
"path": "Profile.structure.element.definition.constraint.human",
"definition": {
"short": "Human description of constraint",
"formal": "Text that can be used to describe the constraint in messages identifying that the constraint has been violated.",
"comments": "Should be expressed in business terms as much as possible.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.constraint.xpath",
"definition": {
"short": "XPath expression of constraint",
"formal": "XPath expression of constraint.",
"comments": "Elements SHALL use \"f\" as the namespace prefix for the FHIR namespace, and \"x\" for the xhtml namespace, and SHALL not use any other prefixes.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.mustSupport",
"definition": {
"short": "If the element must supported",
"formal": "If true, conformant resource authors SHALL be capable of providing a value for the element and resource consumers SHALL be capable of extracting and doing something useful with the data element. If false, the element may be ignored and not supported.",
"comments": "\"Something useful\" is context dependent. This flag is never set to true by the FHIR specification itself - it is only set to true in profiles, and when the profile sets it true, it SHALL describe what it means for applications to support the element. In general, the question is what would a reasonable observer expect of a system that explicitly claims to \"support\" this element?.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.isModifier",
"definition": {
"short": "If this modifies the meaning of other elements",
"formal": "If true, the value of this element affects the interpretation of the element or resource that contains it, and the value of the element cannot be ignored. Typically, this is used for status, negation and qualification codes. The effect of this is that the element cannot be ignored by systems: they SHALL either recognize the element and process it, and/or a pre-determination has been made that it is not relevant to their particular system.",
"comments": "Only the definition of an element can set IsModifier true - either the specification itself or where an extension is originally defined. Once set to false, it cannot be set to true in derived profiles. An element/extension that has isModifier=true SHOULD also have a minimum cardinality of 1, so that there is no lack of clarity about what to do if it is missing. If it can be missing, the definition SHALL make the meaning of a missing element clear.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.binding",
"definition": {
"short": "ValueSet details if this is coded",
"formal": "Binds to a value set if this element is coded (code, Coding, CodeableConcept).",
"min": 0,
"max": "1",
"constraint": [
{
"key": "3",
"severity": "error",
"human": "provide either a reference or a description (or both)",
"xpath": "(exists(f:referenceUri) or exists(f:referenceResource)) or exists(f:description)"
},
{
"key": "14",
"severity": "error",
"human": "Example value sets are always extensible",
"xpath": "not(f:Conformance/value='example' and f:isExtensible.value='false')"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.binding.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.binding.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.binding.name",
"definition": {
"short": "Descriptive Name",
"formal": "A descriptive name for this - can be useful for generating implementation artifacts.",
"comments": "SHALL be unique within the profile. If the same name as an imported profile, will override the imported binding (and SHALL be a proper constraint on the imported binding).",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.binding.isExtensible",
"definition": {
"short": "Can additional codes be used?",
"formal": "If true, then conformant systems may use additional codes or (where the data type permits) text alone to convey concepts not covered by the set of codes identified in the binding. If false, then conformant systems are constrained to the provided codes alone.",
"comments": "When the binding use used for elements with a type of \"code\" (rather than Coding or CodableConcept), the binding is treated as non-extensible regardless of the value of this property.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.binding.conformance",
"definition": {
"short": "required | preferred | example",
"formal": "Indicates the degree of conformance expectations associated with this binding.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "BindingConformance",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/binding-conformance"
}
}
}
},
{
"path": "Profile.structure.element.definition.binding.description",
"definition": {
"short": "Human explanation of the value set",
"formal": "Describes the intended use of this particular set of codes.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.binding.reference[x]",
"definition": {
"short": "Source of value set",
"formal": "Points to the value set or external definition that identifies the set of codes to be used.",
"comments": "For value sets,the referenceResource, the display can contain the value set description. The reference may be version-specific or not.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/ValueSet"
}
],
"constraint": [
{
"key": "13",
"severity": "error",
"human": "uri SHALL start with http:// or https://",
"xpath": "starts-with(@value, 'http:') or starts-with(@value, 'https:')"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.mapping",
"definition": {
"short": "Map element to another set of definitions",
"formal": "Identifies a concept from an external specification that roughly corresponds to this element.",
"comments": "Mappings are not necessarily specific enough for safe translation.",
"min": 0,
"max": "*",
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.mapping.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.mapping.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.mapping.identity",
"definition": {
"short": "Reference to mapping declaration",
"formal": "An internal reference to the definition of a mapping.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.element.definition.mapping.map",
"definition": {
"short": "Details of the mapping",
"formal": "Expresses what part of the target specification corresponds to this element.",
"comments": "For most mappings, the syntax is undefined. Syntax will be provided for mappings to the RIM. Multiple mappings may be possible and may include constraints on other resource elements that identify when a particular mapping applies.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.searchParam",
"definition": {
"short": "Search params defined",
"formal": "Additional search parameters for implementations to support and/or make use of.",
"min": 0,
"max": "*",
"isModifier": false
}
},
{
"path": "Profile.structure.searchParam.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.searchParam.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.searchParam.name",
"definition": {
"short": "Name of search parameter",
"formal": "The name of the standard or custom search parameter.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.searchParam.type",
"definition": {
"short": "number | date | string | token | reference | composite | quantity",
"formal": "The type of value a search parameter refers to, and how the content is interpreted.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "SearchParamType",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/search-param-type"
}
}
}
},
{
"path": "Profile.structure.searchParam.documentation",
"definition": {
"short": "Contents and meaning of search parameter",
"formal": "A specification for search parameters. For standard parameters, provides additional information on how the parameter is used in this solution. For custom parameters, provides a description of what the parameter does.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.searchParam.xpath",
"definition": {
"short": "XPath that extracts the parameter set",
"formal": "An XPath expression that returns a set of elements for the search parameter.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Profile.structure.searchParam.target",
"definition": {
"short": "Types of resource (if a resource reference)",
"formal": "Types of resource (if a resource is referenced).",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "ResourceType",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/resource-types"
}
}
}
},
{
"path": "Profile.extensionDefn",
"definition": {
"short": "Definition of an extension",
"formal": "An extension defined as part of the profile.",
"min": 0,
"max": "*",
"isModifier": false
}
},
{
"path": "Profile.extensionDefn.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Profile.extensionDefn.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Profile.extensionDefn.code",
"definition": {
"short": "Identifies the extension in this profile",
"formal": "A unique code (within the profile) used to identify the extension.",
"comments": "Matches the portion of a reference to an extension after the # in the a url to the profile.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"constraint": [
{
"key": "5",
"severity": "error",
"human": "Codes SHALL be unique in the context of a profile",
"xpath": "count(ancestor::f:Profile/f:extensionDefn/f:code[@value=current()/@value])=1"
}
],
"isModifier": false
}
},
{
"path": "Profile.extensionDefn.display",
"definition": {
"short": "Use this name when displaying the value",
"formal": "Defined so that applications can use this name when displaying the value of the extension to the user.",
"comments": "Applications don't have to use this name, but can always fall back to it.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Profile.extensionDefn.contextType",
"definition": {
"short": "resource | datatype | mapping | extension",
"formal": "Identifies the type of context to which the extension applies.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "ExtensionContext",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/extension-context"
}
}
}
},
{
"path": "Profile.extensionDefn.context",
"definition": {
"short": "Where the extension can be used in instances",
"formal": "Identifies the types of resource or data type elements to which the extension can be applied.",
"min": 1,
"max": "*",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Profile.extensionDefn.definition",
"definition": {
"short": "Definition of the extension and its content",
"formal": "Definition of the extension and its content.",
"min": 1,
"max": "1",
"nameReference": "Profile.structure.element.definition",
"isModifier": false
}
},
{
"path": "Profile.query",
"definition": {
"short": "Definition of a named query",
"formal": "Definition of a named query and its parameters and their meaning.",
"min": 0,
"max": "*",
"isModifier": false
}
},
{
"path": "Profile.query.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Profile.query.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Profile.query.name",
"definition": {
"short": "Special named queries (_query=)",
"formal": "The name of a query, which is used in the URI from Conformance statements declaring use of the query. Typically this will also be the name for the _query parameter when the query is called, though in some cases it may be aliased by a server to avoid collisions.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Profile.query.documentation",
"definition": {
"short": "Describes the named query",
"formal": "Description of the query - the functionality it offers, and considerations about how it functions and to use it.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "Profile.query.parameter",
"definition": {
"short": "Parameter for the named query",
"formal": "A parameter of a named query.",
"min": 0,
"max": "*",
"nameReference": "Profile.structure.searchParam",
"isModifier": false
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "code",
"type": "token",
"documentation": "A code for the profile in the format uri::code (server may choose to do subsumption)",
"xpath": "f:Profile/f:code"
},
{
"name": "date",
"type": "date",
"documentation": "The profile publication date",
"xpath": "f:Profile/f:date"
},
{
"name": "description",
"type": "string",
"documentation": "Text search in the description of the profile",
"xpath": "f:Profile/f:description"
},
{
"name": "extension",
"type": "token",
"documentation": "An extension code (use or definition)",
"xpath": "f:Profile/f:extensionDefn/f:code"
},
{
"name": "identifier",
"type": "token",
"documentation": "The identifier of the profile",
"xpath": "f:Profile/f:identifier"
},
{
"name": "name",
"type": "string",
"documentation": "Name of the profile",
"xpath": "f:Profile/f:name"
},
{
"name": "publisher",
"type": "string",
"documentation": "Name of the publisher of the profile",
"xpath": "f:Profile/f:publisher"
},
{
"name": "status",
"type": "token",
"documentation": "The current status of the profile",
"xpath": "f:Profile/f:status"
},
{
"name": "type",
"type": "token",
"documentation": "Type of resource that is constrained in the profile",
"xpath": "f:Profile/f:structure/f:type"
},
{
"name": "valueset",
"type": "reference",
"documentation": "A vocabulary binding code",
"xpath": "f:Profile/f:structure/f:element/f:definition/f:binding/f:reference[x]"
},
{
"name": "version",
"type": "token",
"documentation": "The version identifier of the profile",
"xpath": "f:Profile/f:version"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"A Resource Profile - a statement of use of one or more FHIR Resources. It may include constraints on Resources and Data Types, Terminology Binding Statements and Extension Definitions.\" class=\"dict\" href=\"profile-definitions.html#Profile\"><b>Profile</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"The identifier that is used to identify this profile when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI).\" class=\"dict\" href=\"profile-definitions.html#Profile.identifier\"><b>identifier</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Logical id to reference this profile<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The identifier that is used to identify this version of the profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.\" class=\"dict\" href=\"profile-definitions.html#Profile.version\"><b>version</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Logical id for this version of the profile<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A free text natural language name identifying the Profile.\" class=\"dict\" href=\"profile-definitions.html#Profile.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Informal name for this profile<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Details of the individual or organization who accepts responsibility for publishing the profile.\" class=\"dict\" href=\"profile-definitions.html#Profile.publisher\"><b>publisher</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Name of the publisher (Organization or individual)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Contact details to assist a user in finding and communicating with the publisher.\" class=\"dict\" href=\"profile-definitions.html#Profile.telecom\"><b>telecom</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">Contact information of the publisher<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></telecom>\r\n <<a title=\"A free text natural language description of the profile and its use.\" class=\"dict\" href=\"profile-definitions.html#Profile.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Natural language description of the profile<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A set of terms from external terminologies that may be used to assist with indexing and searching of templates.\" class=\"dict\" href=\"profile-definitions.html#Profile.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Coding\">Coding</a></span> <span style=\"color: navy\">Assist with indexing and finding<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"The status of the profile (this element modifies the meaning of other elements)\" class=\"dict\" href=\"profile-definitions.html#Profile.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"resource-profile-status.html\">draft | active | retired<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.\" class=\"dict\" href=\"profile-definitions.html#Profile.experimental\"><b>experimental</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">If for testing purposes, not real usage<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The date that this version of the profile was published.\" class=\"dict\" href=\"profile-definitions.html#Profile.date\"><b>date</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Date for this version of the profile<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The Scope and Usage that this profile was created to meet.\" class=\"dict\" href=\"profile-definitions.html#Profile.requirements\"><b>requirements</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Scope and Usage this profile is for</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The version of the FHIR specification on which this profile is based.\" class=\"dict\" href=\"profile-definitions.html#Profile.fhirVersion\"><b>fhirVersion</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#id\">id</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">FHIR Version this profile targets<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"An external specification that the content is mapped to.\" class=\"dict\" href=\"profile-definitions.html#Profile.mapping\"><b>mapping</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> External specification that the content is mapped to --></span>\r\n <<a title=\"An Internal id that is used to identify this mapping set when specific mappings are made.\" class=\"dict\" href=\"profile-definitions.html#Profile.mapping.identity\"><b>identity</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#id\">id</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Internal id when this mapping is used</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A URI that identifies the specification that this mapping is expressed to.\" class=\"dict\" href=\"profile-definitions.html#Profile.mapping.uri\"><b>uri</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-26: Must have at a name or a uri (or both)\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Identifies what this mapping refers to</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A name for the specification that is being mapped to.\" class=\"dict\" href=\"profile-definitions.html#Profile.mapping.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-26: Must have at a name or a uri (or both)\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Names what this mapping refers to</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage.\" class=\"dict\" href=\"profile-definitions.html#Profile.mapping.comments\"><b>comments</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Versions, Issues, Scope limitations etc</span><span style=\"color: Gray\"> --></span>\r\n </mapping>\r\n <<a title=\"A constraint statement about what contents a resource or data type may have.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure\"><b>structure</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-8: SHALL define at least one structure constraint or extension definition\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> A constraint on a resource or a data type --></span>\r\n <<a title=\"The Resource or Data type being described.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.type\"><b>type</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-12: Only complex types can be constrained, not primitive types such as string etc.\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"defined-types.html\">The Resource or Data Type being described</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The name of this resource constraint statement (to refer to it from other resource constraints - from Profile.structure.element.definition.type.profile).\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Name for this particular structure (reference target)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"This definition of a profile on a structure is published as a formal statement. Some structural definitions might be defined purely for internal use within the profile, and not intended to be used outside that context.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.publish\"><b>publish</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">This definition is published (i.e. for validation)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Human summary: why describe this resource?.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.purpose\"><b>purpose</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Human summary: why describe this resource?</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Captures constraints on each element within the resource.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element\"><b>element</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Definition of elements in the resource (if no profile) --></span>\r\n <<a title=\"The path identifies the element and is expressed as a "."-separated list of ancestor elements, beginning with the name of the resource.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.path\"><b>path</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">The path of the element (see the formal definitions)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Codes that define how this element is represented in instances, when the deviation varies from the normal case.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.representation\"><b>representation</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"property-representation.html\">How this element is represented in instances</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The name of this element definition (to refer to it from other element definitions using Profile.structure.element.definition.nameReference). This is a unique name referring to a specific set of constraints applied to this element. One use of this is to provide a name to different slices of the same element.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Name for this particular element definition (reference target)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Indicates that the element is sliced into a set of alternative definitions (there are multiple definitions on a single element in the base resource). The set of slices is any elements that come after this in the element sequence that have the same path, until a shorter path occurs (the shorter path terminates the set).\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.slicing\"><b>slicing</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> This element is sliced - slices follow --></span>\r\n <<a title=\"Designates which child element is used to discriminate between the slices when processing an instance. The value of the child element in the instance SHALL completely distinguish which slice the element in the resource matches based on the allowed values for that element in each of the slices.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.slicing.discriminator\"><b>discriminator</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#id\">id</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Element that used to distinguish the slices</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"If the matching elements have to occur in the same order as defined in the profile.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.slicing.ordered\"><b>ordered</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">If elements must be in same order as slices</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Whether additional slices are allowed or not. When the slices are ordered, profile authors can also say that additional slices are only allowed at the end.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.slicing.rules\"><b>rules</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"resource-slicing-rules.html\">closed | open | openAtEnd</a></span><span style=\"color: Gray\"> --></span>\r\n </slicing>\r\n <<a title=\"Definition of the content of the element to provide a more specific definition than that contained for the element in the base resource.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition\"><b>definition</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> More specific definition of the element --></span>\r\n <<a title=\"A concise definition that is shown in the generated XML format that summarizes profiles (used throughout the specification).\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.short\"><b>short</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Concise definition for xml presentation</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The definition SHALL be consistent with the base definition, but convey the meaning of the element in the particular context of use of the resource.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.formal\"><b>formal</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Full formal definition in human language</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Comments about the use of the element, including notes about how to use the data properly, exceptions to proper use, etc.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.comments\"><b>comments</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Comments about the use of this element</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Explains why this element is needed and why it's been constrained as it has.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.requirements\"><b>requirements</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Why is this needed?</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identifies additional names by which this element might also be known.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.synonym\"><b>synonym</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: navy\">Other names</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The minimum number of times this element SHALL appear in the instance.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.min\"><b>min</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Minimum Cardinality</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The maximum number of times this element is permitted to appear in the instance.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.max\"><b>max</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-6: Max SHALL be a number or "*"\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 1..1</b></span> <span style=\"color: navy\">Maximum Cardinality (a number or *)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The data type or resource that the value of this element is permitted to be.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.type\"><b>type</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Data type and Profile for this element --></span>\r\n <<a title=\"Name of Data type or Resource.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.type.code\"><b>code</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"data-types.html\">Name of Data type or Resource</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identifies a profile that SHALL hold for resources or datatypes referenced as the type of this element. Can be a local reference - to another structure in this profile, or a reference to a structure in another profile.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.type.profile\"><b>profile</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-8: SHALL define at least one structure constraint or extension definition\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Profile.structure to apply</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"If the type is a reference to another resource, how the resource is or can be aggreated - is it a contained resource, or a reference, and if the context is a bundle, is it included in the bundle.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.type.aggregation\"><b>aggregation</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-9: Aggregation may only be specified if one of the allowed types for the element is a resource\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"resource-aggregation-mode.html\">contained | referenced | bundled - how aggregated</a></span><span style=\"color: Gray\"> --></span>\r\n </type>\r\n <<a title=\"Identifies the name of a slice defined elsewhere in the profile whose constraints should be applied to the current element.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.nameReference\"><b>nameReference</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: Either a namereference or a fixed value (but not both) is permitted\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">To another element constraint (by element.name)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Specifies a primitive value that SHALL hold for this element in the instance.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.value_x_\"><b>value[x]</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: Either a namereference or a fixed value (but not both) is permitted; Inv-10: Value may only be specified if the type consists of a single repetition that has a type corresponding to one of the primitive data types.\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#open\">*</a></span> <span style=\"color: navy\">Fixed value: [as defined for a primitive type]</span><span style=\"color: Gray\"> --></span></value[x]>\r\n <<a title=\"An example value for this element.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.example_x_\"><b>example[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#open\">*</a></span> <span style=\"color: navy\">Example value: [as defined for type]</span><span style=\"color: Gray\"> --></span></example[x]>\r\n <<a title=\"Indicates the shortest length that SHALL be supported by conformant instances without truncation.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.maxLength\"><b>maxLength</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Length for strings</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A reference to an invariant that may make additional statements about the cardinality or value in the instance.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.condition\"><b>condition</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#id\">id</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: navy\">Reference to invariant about presence</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.constraint\"><b>constraint</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Condition that must evaluate to true --></span>\r\n <<a title=\"Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.constraint.key\"><b>key</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#id\">id</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Target of 'condition' reference above</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Used to label the constraint in OCL or in short displays incapable of displaying the full human description.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.constraint.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Short human label</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identifies the impact constraint violation has on the conformance of the instance.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.constraint.severity\"><b>severity</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"constraint-severity.html\">error | warning</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Text that can be used to describe the constraint in messages identifying that the constraint has been violated.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.constraint.human\"><b>human</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Human description of constraint</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"XPath expression of constraint.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.constraint.xpath\"><b>xpath</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">XPath expression of constraint</span><span style=\"color: Gray\"> --></span>\r\n </constraint>\r\n <<a title=\"If true, conformant resource authors SHALL be capable of providing a value for the element and resource consumers SHALL be capable of extracting and doing something useful with the data element. If false, the element may be ignored and not supported.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.mustSupport\"><b>mustSupport</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">If the element must supported</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"If true, the value of this element affects the interpretation of the element or resource that contains it, and the value of the element cannot be ignored. Typically, this is used for status, negation and qualification codes. The effect of this is that the element cannot be ignored by systems: they SHALL either recognize the element and process it, and/or a pre-determination has been made that it is not relevant to their particular system.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.isModifier\"><b>isModifier</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">If this modifies the meaning of other elements</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Binds to a value set if this element is coded (code, Coding, CodeableConcept).\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.binding\"><b>binding</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-12: Only complex types can be constrained, not primitive types such as string etc.\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> ValueSet details if this is coded --></span>\r\n <<a title=\"A descriptive name for this - can be useful for generating implementation artifacts.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.binding.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-11: Must have either a slice or a definition, but not both\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 1..1</b></span> <span style=\"color: navy\">Descriptive Name</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"If true, then conformant systems may use additional codes or (where the data type permits) text alone to convey concepts not covered by the set of codes identified in the binding. If false, then conformant systems are constrained to the provided codes alone.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.binding.isExtensible\"><b>isExtensible</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-14: Example value sets are always extensible\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 1..1</b></span> <span style=\"color: navy\">Can additional codes be used?</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Indicates the degree of conformance expectations associated with this binding.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.binding.conformance\"><b>conformance</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-14: Example value sets are always extensible\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"binding-conformance.html\">required | preferred | example</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Describes the intended use of this particular set of codes.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.binding.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-3: provide either a reference or a description (or both)\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Human explanation of the value set</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Points to the value set or external definition that identifies the set of codes to be used.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.binding.reference_x_\"><b>reference[x]</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-3: provide either a reference or a description (or both)\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a>|<a href=\"references.html#Resource\">Resource</a>(<a href=\"valueset.html#ValueSet\">ValueSet</a>)</span> <span style=\"color: navy\">Source of value set</span><span style=\"color: Gray\"> --></span></reference[x]>\r\n </binding>\r\n <<a title=\"Identifies a concept from an external specification that roughly corresponds to this element.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.mapping\"><b>mapping</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Map element to another set of definitions --></span>\r\n <<a title=\"An internal reference to the definition of a mapping.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.mapping.identity\"><b>identity</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#id\">id</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-26: Must have at a name or a uri (or both)\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 1..1</b></span> <span style=\"color: navy\">Reference to mapping declaration</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Expresses what part of the target specification corresponds to this element.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.element.definition.mapping.map\"><b>map</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Details of the mapping</span><span style=\"color: Gray\"> --></span>\r\n </mapping>\r\n </definition>\r\n </element>\r\n <<a title=\"Additional search parameters for implementations to support and/or make use of.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.searchParam\"><b>searchParam</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Search params defined --></span>\r\n <<a title=\"The name of the standard or custom search parameter.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.searchParam.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Name of search parameter</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The type of value a search parameter refers to, and how the content is interpreted.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.searchParam.type\"><b>type</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"search-param-type.html\">number | date | string | token | reference | composite | quantity</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A specification for search parameters. For standard parameters, provides additional information on how the parameter is used in this solution. For custom parameters, provides a description of what the parameter does.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.searchParam.documentation\"><b>documentation</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Contents and meaning of search parameter</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"An XPath expression that returns a set of elements for the search parameter.\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.searchParam.xpath\"><b>xpath</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">XPath that extracts the parameter set</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Types of resource (if a resource is referenced).\" class=\"dict\" href=\"profile-definitions.html#Profile.structure.searchParam.target\"><b>target</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"resource-types.html\">Types of resource (if a resource reference)</a></span><span style=\"color: Gray\"> --></span>\r\n </searchParam>\r\n </structure>\r\n <<a title=\"An extension defined as part of the profile.\" class=\"dict\" href=\"profile-definitions.html#Profile.extensionDefn\"><b>extensionDefn</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-8: SHALL define at least one structure constraint or extension definition\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> Definition of an extension --></span>\r\n <<a title=\"A unique code (within the profile) used to identify the extension.\" class=\"dict\" href=\"profile-definitions.html#Profile.extensionDefn.code\"><b>code</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-5: Codes SHALL be unique in the context of a profile\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 1..1</b></span> <span style=\"color: navy\">Identifies the extension in this profile</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Defined so that applications can use this name when displaying the value of the extension to the user.\" class=\"dict\" href=\"profile-definitions.html#Profile.extensionDefn.display\"><b>display</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Use this name when displaying the value</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identifies the type of context to which the extension applies.\" class=\"dict\" href=\"profile-definitions.html#Profile.extensionDefn.contextType\"><b>contextType</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"extension-context.html\">resource | datatype | mapping | extension</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identifies the types of resource or data type elements to which the extension can be applied.\" class=\"dict\" href=\"profile-definitions.html#Profile.extensionDefn.context\"><b>context</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..*</b></span> <span style=\"color: navy\">Where the extension can be used in instances</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Definition of the extension and its content.\" class=\"dict\" href=\"profile-definitions.html#Profile.extensionDefn.definition\"><b>definition</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\">Content as for Profile.structure.element.definition</span> <span style=\"color: navy\">Definition of the extension and its content</span><span style=\"color: Gray\"> --></span></definition>\r\n </extensionDefn>\r\n <<a title=\"Definition of a named query and its parameters and their meaning.\" class=\"dict\" href=\"profile-definitions.html#Profile.query\"><b>query</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Definition of a named query --></span>\r\n <<a title=\"The name of a query, which is used in the URI from Conformance statements declaring use of the query. Typically this will also be the name for the _query parameter when the query is called, though in some cases it may be aliased by a server to avoid collisions.\" class=\"dict\" href=\"profile-definitions.html#Profile.query.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Special named queries (_query=)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Description of the query - the functionality it offers, and considerations about how it functions and to use it.\" class=\"dict\" href=\"profile-definitions.html#Profile.query.documentation\"><b>documentation</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Describes the named query</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A parameter of a named query.\" class=\"dict\" href=\"profile-definitions.html#Profile.query.parameter\"><b>parameter</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\">Content as for Profile.structure.searchParam</span> <span style=\"color: navy\">Parameter for the named query</span><span style=\"color: Gray\"> --></span></parameter>\r\n </query>\r\n</Profile>\r\n</pre></div>"
},
{
"title": "\"provenance\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/provenance",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/provenance.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"Provenance information that describes the activity that led to the creation of a set of resources. This information can be used to help determine their reliability or trace where the information in them came from. The focus of the provenance resource is record keeping, audit and traceability, and not explicit statements of clinical significance.\" class=\"dict\" href=\"provenance-definitions.html#Provenance\"><b>Provenance</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"The resource(s) that were generated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.target\"><b>target</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">Target resource(s) (usually version specific)</span><span style=\"color: Gray\"> --></span></target>\r\n <<a title=\"The period during which the activity occurred.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.period\"><b>period</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">When the activity occurred</span><span style=\"color: Gray\"> --></span></period>\r\n <<a title=\"The instant of time at which the activity was recorded.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.recorded\"><b>recorded</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#instant\">instant</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">When the activity was recorded / updated</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The reason that the activity was taking place.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.reason\"><b>reason</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Reason the activity is occurring</span><span style=\"color: Gray\"> --></span></reason>\r\n <<a title=\"Where the activity occurred, if relevant.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.location\"><b>location</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">Where the activity occurred, if relevant</span><span style=\"color: Gray\"> --></span></location>\r\n <<a title=\"Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.policy\"><b>policy</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: navy\">Policy or plan the activity was defined by</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"An agent takes a role in an activity such that the agent can be assigned some degree of responsibility for the activity taking place. An agent can be a person, a piece of software, an inanimate object, an organization, or other entities that may be ascribed responsibility.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.agent\"><b>agent</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Person, organization, records, etc. involved in creating resource --></span>\r\n <<a title=\"The role that the participant played.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.agent.role\"><b>role</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Coding\">Coding</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-provenance-agent-role.html\">e.g. author | overseer | enterer | attester | source | cc: +</a></span><span style=\"color: Gray\"> --></span></role>\r\n <<a title=\"The type of the participant.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.agent.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Coding\">Coding</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-provenance-agent-type.html\">e.g. Resource | Person | Application | Record | Document +</a></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"Identity of participant. May be a logical or physical uri and maybe absolute or relative.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.agent.reference\"><b>reference</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Identity of agent (urn or url)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Human-readable description of the participant.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.agent.display\"><b>display</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Human description of participant</span><span style=\"color: Gray\"> --></span>\r\n </agent>\r\n <<a title=\"An entity used in this activity.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.entity\"><b>entity</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> An entity used in this activity --></span>\r\n <<a title=\"How the entity was used during the activity.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.entity.role\"><b>role</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"provenance-entity-role.html\">derivation | revision | quotation | source</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The type of the entity. If the entity is a resource, then this is a resource type.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.entity.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Coding\">Coding</a></span> <a style=\"color: navy\" href=\"resource-types.html\">Resource Type, or something else</a><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"Identity of participant. May be a logical or physical uri and maybe absolute or relative.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.entity.reference\"><b>reference</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Identity of participant (urn or url)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Human-readable description of the entity.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.entity.display\"><b>display</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Human description of participant</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.entity.agent\"><b>agent</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\">Content as for Provenance.agent</span> <span style=\"color: navy\">Entity is attributed to this agent</span><span style=\"color: Gray\"> --></span></agent>\r\n </entity>\r\n <<a title=\"A digital signature on the target resource(s). The signature should match a Provenance.agent.reference in the provenance resource. The signature is only added to support checking cryptographic integrity of the resource, and not to represent workflow and clinical aspects of the signing process, or to support non-repudiation.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.integritySignature\"><b>integritySignature</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Base64 signature (DigSig) - integrity check</span><span style=\"color: Gray\"> --></span>\r\n</Provenance>\r\n</pre></div>"
},
"name": "provenance",
"publisher": "FHIR Project",
"description": "Basic Profile. Provenance information that describes the activity that led to the creation of a set of resources. This information can be used to help determine their reliability or trace where the information in them came from. The focus of the provenance resource is record keeping, audit and traceability, and not explicit statements of clinical significance.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage The provenance resource tracks information about activity that created a version of a resource, including the entities, and agents involved in producing a resource. This information can be used to form assessments about its quality, reliability or trustworthiness, or to provide pointers for where to go to further investigate the origins of the resource and the information in it. \r\n\r\nProvenance resources are a record-keeping assertion that gathers information about the context in which the information in a resource was obtained. Provenance resources are prepared by the application that initiates the create/update etc. of the resource. A Security Event resource contains overlapping information, but is created as events occur, to track and audit the events. Security Event resources are often (though not exclusively) created by the application responding to the read/query/create/update etc. event.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "w3c.prov",
"uri": "http://www.w3.org/ns/prov",
"name": "W3C PROV"
}
],
"structure": [
{
"type": "Provenance",
"publish": true,
"element": [
{
"path": "Provenance",
"definition": {
"short": "Who, What, When for a set of resources",
"formal": "Provenance information that describes the activity that led to the creation of a set of resources. This information can be used to help determine their reliability or trace where the information in them came from. The focus of the provenance resource is record keeping, audit and traceability, and not explicit statements of clinical significance.",
"comments": "Some parties may be duplicated between the target resource and its provenance. For instance, the prescriber is usually (but not always) the author of the prescription resource. This resource is defined with close consideration for W3C Provenance.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "ControlAct[isNormalAct() and subsumes(CACT, classCode) and moodCode=EVN]"
},
{
"identity": "w3c.prov",
"map": "Activity"
}
]
}
},
{
"path": "Provenance.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Provenance.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Provenance.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "Provenance.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "Provenance.target",
"definition": {
"short": "Target resource(s) (usually version specific)",
"formal": "The resource(s) that were generated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.",
"comments": "Target references are usually version specific, but may not be, if a version has not been assigned or if the provenance information is part of the set of resources being maintained (i.e. a document). When using the RESTful API, the identity of the resource may not be known (especially not the version specific one); the client may either submit the resource first, and then the provenance, or it may submit both using a single transaction. See the notes on transaction for further discussion.",
"min": 1,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Any"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./outboundRelationship[isNormalActRelationship() and typeCode=SUBJ]/target\n\nOR\n\n./participation[isNormalParticipation() and typeCode=SBJ]/role\n\nOR\n\n./participation[isNormalParticipation() and typeCode=SBJ]/role[isNormalRole()]/player"
},
{
"identity": "w3c.prov",
"map": "Activity.wasGeneratedBy"
}
]
}
},
{
"path": "Provenance.period",
"definition": {
"short": "When the activity occurred",
"formal": "The period during which the activity occurred.",
"comments": "The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./effectiveTime[type=IVL_TS]"
},
{
"identity": "w3c.prov",
"map": "Activity.startTime & Activity.endTime"
}
]
}
},
{
"path": "Provenance.recorded",
"definition": {
"short": "When the activity was recorded / updated",
"formal": "The instant of time at which the activity was recorded.",
"comments": "This can be a little different from the time stamp on the resource if there is a delay between recording the event and updating the provenance and target resource.",
"min": 1,
"max": "1",
"type": [
{
"code": "instant"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "unique(./participation[isNormalParticipation() and typeCode=AUT]/time[type=TS])"
}
]
}
},
{
"path": "Provenance.reason",
"definition": {
"short": "Reason the activity is occurring",
"formal": "The reason that the activity was taking place.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "unique(./reasonCode)"
}
]
}
},
{
"path": "Provenance.location",
"definition": {
"short": "Where the activity occurred, if relevant",
"formal": "Where the activity occurred, if relevant.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Location"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "unique(./participation[isNormalParticipation() and typeCode=LOC]/role[isNormalRole() and subsumes(SDLOC, classCode)]/player[isNormalEntity and classCode=\"LOC\" and determinerCode=\"INST\"]"
},
{
"identity": "w3c.prov",
"map": "Activity.location"
}
]
}
},
{
"path": "Provenance.policy",
"definition": {
"short": "Policy or plan the activity was defined by",
"formal": "Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./inboundRelationship[isNormalActRelationship() and typeCode=\"SUBJ\"]/source[isNormalAct and subsumes(POLICY, classCode) and moodCode=EVN]/text[typeCode='ED'/tel"
}
]
}
},
{
"path": "Provenance.agent",
"definition": {
"short": "Person, organization, records, etc. involved in creating resource",
"formal": "An agent takes a role in an activity such that the agent can be assigned some degree of responsibility for the activity taking place. An agent can be a person, a piece of software, an inanimate object, an organization, or other entities that may be ascribed responsibility.",
"comments": "Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./participation[isNormalParticipation()]\n\nOR\n\n./outboundRelationship[isNormalActRelationship() and typeCode='DRIV']"
}
]
}
},
{
"path": "Provenance.agent.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Provenance.agent.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Provenance.agent.role",
"definition": {
"short": "e.g. author | overseer | enterer | attester | source | cc: +",
"formal": "The role that the participant played.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isModifier": false,
"binding": {
"name": "ProvenanceAgentRole",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/provenance-agent-role"
}
},
"mapping": [
{
"identity": "rim",
"map": "attester: .[self::participation]/typeCode='RESP'\nauthor: .[self::participation]/typeCode='AUT'\ncc: .[self::participation]/typeCode='IRCP'\nenterer: .[self::participation]/typeCode='ENT'\ninformant: .[self::participation]/typeCode='INF'\nperformer: .[self::participation]/typeCode='PRF'\nverifier: .[self::participation]/typeCode='VRF'\nsource: .[self::outboundRelationship]/typeCode=''"
}
]
}
},
{
"path": "Provenance.agent.type",
"definition": {
"short": "e.g. Resource | Person | Application | Record | Document +",
"formal": "The type of the participant.",
"comments": "If the type is \"Resource\" then the resource itself was the participant. If the type is a type of resource, then the entity identified by the resource is the participant.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isModifier": false,
"binding": {
"name": "ProvenanceAgentType",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/provenance-agent-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "person: ./role[isNormalRole() and classCode='REL']/player[isNormalEntity and classCode='PER' and determinerCode='INST']\nagent: ./role[isNormalRole() and classCode='ASSIGNED' and player[isNormalEntity and classCode='PSN' and determinerCode='INST']]\norganization: ./role[isNormalRole() and classCode='ASSIGNED' and not(player)]/scoper[isNormalEntity and classCode='ORG' and determinerCode='INST']\n\nsoftware: ./role[isNormalRole() and classCode='ASSIGNED']/scoper[isNormalEntity and classCode='DEV' and determinerCode='INST' and hasDomain(code, 'Software')]\ndocument: ./target[isNormalAct and subsumes('DOC', classCode) and moodCode='EVN']"
}
]
}
},
{
"path": "Provenance.agent.reference",
"definition": {
"short": "Identity of agent (urn or url)",
"formal": "Identity of participant. May be a logical or physical uri and maybe absolute or relative.",
"comments": "identity may be a reference to a resource or to something else, depending on the type.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./id"
}
]
}
},
{
"path": "Provenance.agent.display",
"definition": {
"short": "Human description of participant",
"formal": "Human-readable description of the participant.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./player/description\n\nOR\n\n./description\n\nOR\n\n./text"
},
{
"identity": "w3c.prov",
"map": "Agent.label"
}
]
}
},
{
"path": "Provenance.entity",
"definition": {
"short": "An entity used in this activity",
"formal": "An entity used in this activity.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./subjectOf"
}
]
}
},
{
"path": "Provenance.entity.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Provenance.entity.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Provenance.entity.role",
"definition": {
"short": "derivation | revision | quotation | source",
"formal": "How the entity was used during the activity.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "ProvenanceEntityRole",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/provenance-entity-role"
}
},
"mapping": [
{
"identity": "rim",
"map": "./typeCode"
}
]
}
},
{
"path": "Provenance.entity.type",
"definition": {
"short": "Resource Type, or something else",
"formal": "The type of the entity. If the entity is a resource, then this is a resource type.",
"comments": "If the type is \"resource\" then the resource itself was the participant. If the type is a type of resource, then the entity identified by the resource is the participant.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isModifier": false,
"binding": {
"name": "ProvenanceEntityType",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/resource-types"
}
},
"mapping": [
{
"identity": "rim",
"map": "./target"
},
{
"identity": "w3c.prov",
"map": "Entity.type"
}
]
}
},
{
"path": "Provenance.entity.reference",
"definition": {
"short": "Identity of participant (urn or url)",
"formal": "Identity of participant. May be a logical or physical uri and maybe absolute or relative.",
"comments": "identity may be a reference to a resource or to something else, depending on the type.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./text/reference"
}
]
}
},
{
"path": "Provenance.entity.display",
"definition": {
"short": "Human description of participant",
"formal": "Human-readable description of the entity.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./title"
}
]
}
},
{
"path": "Provenance.entity.agent",
"definition": {
"short": "Entity is attributed to this agent",
"formal": "The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity.",
"min": 0,
"max": "1",
"nameReference": "Provenance.agent",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./author/role"
}
]
}
},
{
"path": "Provenance.integritySignature",
"definition": {
"short": "Base64 signature (DigSig) - integrity check",
"formal": "A digital signature on the target resource(s). The signature should match a Provenance.agent.reference in the provenance resource. The signature is only added to support checking cryptographic integrity of the resource, and not to represent workflow and clinical aspects of the signing process, or to support non-repudiation.",
"comments": "Whether the content is XML or JSON, the representation is as a base64 of the XML signature of the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./signatureText"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "end",
"type": "date",
"documentation": "End time with inclusive boundary, if not ongoing",
"xpath": "f:Provenance/f:period/f:end"
},
{
"name": "location",
"type": "reference",
"documentation": "Where the activity occurred, if relevant",
"xpath": "f:Provenance/f:location"
},
{
"name": "party",
"type": "token",
"documentation": "Identity of agent (urn or url)",
"xpath": "f:Provenance/f:agent/f:reference"
},
{
"name": "partytype",
"type": "token",
"documentation": "e.g. Resource | Person | Application | Record | Document +",
"xpath": "f:Provenance/f:agent/f:type"
},
{
"name": "start",
"type": "date",
"documentation": "Starting time with inclusive boundary",
"xpath": "f:Provenance/f:period/f:start"
},
{
"name": "target",
"type": "reference",
"documentation": "Target resource(s) (usually version specific)",
"xpath": "f:Provenance/f:target"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"Provenance information that describes the activity that led to the creation of a set of resources. This information can be used to help determine their reliability or trace where the information in them came from. The focus of the provenance resource is record keeping, audit and traceability, and not explicit statements of clinical significance.\" class=\"dict\" href=\"provenance-definitions.html#Provenance\"><b>Provenance</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"The resource(s) that were generated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.target\"><b>target</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">Target resource(s) (usually version specific)</span><span style=\"color: Gray\"> --></span></target>\r\n <<a title=\"The period during which the activity occurred.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.period\"><b>period</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">When the activity occurred</span><span style=\"color: Gray\"> --></span></period>\r\n <<a title=\"The instant of time at which the activity was recorded.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.recorded\"><b>recorded</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#instant\">instant</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">When the activity was recorded / updated</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The reason that the activity was taking place.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.reason\"><b>reason</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Reason the activity is occurring</span><span style=\"color: Gray\"> --></span></reason>\r\n <<a title=\"Where the activity occurred, if relevant.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.location\"><b>location</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">Where the activity occurred, if relevant</span><span style=\"color: Gray\"> --></span></location>\r\n <<a title=\"Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.policy\"><b>policy</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: navy\">Policy or plan the activity was defined by</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"An agent takes a role in an activity such that the agent can be assigned some degree of responsibility for the activity taking place. An agent can be a person, a piece of software, an inanimate object, an organization, or other entities that may be ascribed responsibility.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.agent\"><b>agent</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Person, organization, records, etc. involved in creating resource --></span>\r\n <<a title=\"The role that the participant played.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.agent.role\"><b>role</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Coding\">Coding</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-provenance-agent-role.html\">e.g. author | overseer | enterer | attester | source | cc: +</a></span><span style=\"color: Gray\"> --></span></role>\r\n <<a title=\"The type of the participant.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.agent.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Coding\">Coding</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-provenance-agent-type.html\">e.g. Resource | Person | Application | Record | Document +</a></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"Identity of participant. May be a logical or physical uri and maybe absolute or relative.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.agent.reference\"><b>reference</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Identity of agent (urn or url)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Human-readable description of the participant.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.agent.display\"><b>display</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Human description of participant</span><span style=\"color: Gray\"> --></span>\r\n </agent>\r\n <<a title=\"An entity used in this activity.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.entity\"><b>entity</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> An entity used in this activity --></span>\r\n <<a title=\"How the entity was used during the activity.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.entity.role\"><b>role</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"provenance-entity-role.html\">derivation | revision | quotation | source</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The type of the entity. If the entity is a resource, then this is a resource type.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.entity.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Coding\">Coding</a></span> <a style=\"color: navy\" href=\"resource-types.html\">Resource Type, or something else</a><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"Identity of participant. May be a logical or physical uri and maybe absolute or relative.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.entity.reference\"><b>reference</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Identity of participant (urn or url)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Human-readable description of the entity.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.entity.display\"><b>display</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Human description of participant</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.entity.agent\"><b>agent</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\">Content as for Provenance.agent</span> <span style=\"color: navy\">Entity is attributed to this agent</span><span style=\"color: Gray\"> --></span></agent>\r\n </entity>\r\n <<a title=\"A digital signature on the target resource(s). The signature should match a Provenance.agent.reference in the provenance resource. The signature is only added to support checking cryptographic integrity of the resource, and not to represent workflow and clinical aspects of the signing process, or to support non-repudiation.\" class=\"dict\" href=\"provenance-definitions.html#Provenance.integritySignature\"><b>integritySignature</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Base64 signature (DigSig) - integrity check</span><span style=\"color: Gray\"> --></span>\r\n</Provenance>\r\n</pre></div>"
},
{
"title": "\"query\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/query",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/query.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"A description of a query with a set of parameters.\" class=\"dict\" href=\"query-definitions.html#Query\"><b>Query</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Links query and its response(s).\" class=\"dict\" href=\"query-definitions.html#Query.identifier\"><b>identifier</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Links query and its response(s)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Set of query parameters with values.\" class=\"dict\" href=\"query-definitions.html#Query.parameter\"><b>parameter</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..*</b></span> <span style=\"color: darkgreen\"><a href=\"extensibility.html#Extension\">Extension</a></span> <span style=\"color: navy\">Set of query parameters with values</span><span style=\"color: Gray\"> --></span></parameter>\r\n <<a title=\"If this is a response to a query.\" class=\"dict\" href=\"query-definitions.html#Query.response\"><b>response</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> If this is a response to a query --></span>\r\n <<a title=\"Links response to source query.\" class=\"dict\" href=\"query-definitions.html#Query.response.identifier\"><b>identifier</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Links response to source query</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Outcome of processing the query.\" class=\"dict\" href=\"query-definitions.html#Query.response.outcome\"><b>outcome</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"query-outcome.html\">ok | limited | refused | error</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Total number of matching records.\" class=\"dict\" href=\"query-definitions.html#Query.response.total\"><b>total</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Total number of matching records</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Parameters server used.\" class=\"dict\" href=\"query-definitions.html#Query.response.parameter\"><b>parameter</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"extensibility.html#Extension\">Extension</a></span> <span style=\"color: navy\">Parameters server used</span><span style=\"color: Gray\"> --></span></parameter>\r\n <<a title=\"To get first page (if paged).\" class=\"dict\" href=\"query-definitions.html#Query.response.first\"><b>first</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"extensibility.html#Extension\">Extension</a></span> <span style=\"color: navy\">To get first page (if paged)</span><span style=\"color: Gray\"> --></span></first>\r\n <<a title=\"To get previous page (if paged).\" class=\"dict\" href=\"query-definitions.html#Query.response.previous\"><b>previous</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"extensibility.html#Extension\">Extension</a></span> <span style=\"color: navy\">To get previous page (if paged)</span><span style=\"color: Gray\"> --></span></previous>\r\n <<a title=\"To get next page (if paged).\" class=\"dict\" href=\"query-definitions.html#Query.response.next\"><b>next</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"extensibility.html#Extension\">Extension</a></span> <span style=\"color: navy\">To get next page (if paged)</span><span style=\"color: Gray\"> --></span></next>\r\n <<a title=\"To get last page (if paged).\" class=\"dict\" href=\"query-definitions.html#Query.response.last\"><b>last</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"extensibility.html#Extension\">Extension</a></span> <span style=\"color: navy\">To get last page (if paged)</span><span style=\"color: Gray\"> --></span></last>\r\n <<a title=\"Resources that are the results of the search.\" class=\"dict\" href=\"query-definitions.html#Query.response.reference\"><b>reference</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">Resources that are the results of the search</span><span style=\"color: Gray\"> --></span></reference>\r\n </response>\r\n</Query>\r\n</pre></div>"
},
"name": "query",
"publisher": "FHIR Project",
"description": "Basic Profile. A description of a query with a set of parameters.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage The resource is used to perform queries using messaging-based exchanges, and to perform asynchronous searches using the RESTful interface.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"structure": [
{
"type": "Query",
"publish": true,
"element": [
{
"path": "Query",
"definition": {
"short": "A description of a query with a set of parameters",
"formal": "A description of a query with a set of parameters.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "QuerySpec"
}
]
}
},
{
"path": "Query.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Query.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Query.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "Query.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "Query.identifier",
"definition": {
"short": "Links query and its response(s)",
"formal": "Links query and its response(s).",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".queryId"
}
]
}
},
{
"path": "Query.parameter",
"definition": {
"short": "Set of query parameters with values",
"formal": "Set of query parameters with values.",
"comments": "Unless otherwise specified, parameters are usually strings.",
"min": 1,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".parameter"
}
]
}
},
{
"path": "Query.response",
"definition": {
"short": "If this is a response to a query",
"formal": "If this is a response to a query.",
"min": 0,
"max": "1",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "QueryAck (indirectly linked through .queryId, directly linked via Message.acknowledges"
}
]
}
},
{
"path": "Query.response.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Query.response.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Query.response.identifier",
"definition": {
"short": "Links response to source query",
"formal": "Links response to source query.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".queryId?"
}
]
}
},
{
"path": "Query.response.outcome",
"definition": {
"short": "ok | limited | refused | error",
"formal": "Outcome of processing the query.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "QueryOutcome",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/query-outcome"
}
},
"mapping": [
{
"identity": "rim",
"map": ".queryResponseCode"
}
]
}
},
{
"path": "Query.response.total",
"definition": {
"short": "Total number of matching records",
"formal": "Total number of matching records.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".resultTotalQuantity"
}
]
}
},
{
"path": "Query.response.parameter",
"definition": {
"short": "Parameters server used",
"formal": "Parameters server used.",
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Not supported"
}
]
}
},
{
"path": "Query.response.first",
"definition": {
"short": "To get first page (if paged)",
"formal": "To get first page (if paged).",
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Not supported"
}
]
}
},
{
"path": "Query.response.previous",
"definition": {
"short": "To get previous page (if paged)",
"formal": "To get previous page (if paged).",
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Not supported"
}
]
}
},
{
"path": "Query.response.next",
"definition": {
"short": "To get next page (if paged)",
"formal": "To get next page (if paged).",
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".continuationToken"
}
]
}
},
{
"path": "Query.response.last",
"definition": {
"short": "To get last page (if paged)",
"formal": "To get last page (if paged).",
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Not supported"
}
]
}
},
{
"path": "Query.response.reference",
"definition": {
"short": "Resources that are the results of the search",
"formal": "Resources that are the results of the search.",
"comments": "Is query only used in messaging?.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Any"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".controlAct.outboundRelationship[typeCode=SUBJ].target\nor\n.controlAct.participation[typeCode=SBJ].role"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "identifier",
"type": "token",
"documentation": "Links query and its response(s)",
"xpath": "f:Query/f:identifier"
},
{
"name": "response",
"type": "token",
"documentation": "Links response to source query",
"xpath": "f:Query/f:response/f:identifier"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"A description of a query with a set of parameters.\" class=\"dict\" href=\"query-definitions.html#Query\"><b>Query</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Links query and its response(s).\" class=\"dict\" href=\"query-definitions.html#Query.identifier\"><b>identifier</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Links query and its response(s)</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Set of query parameters with values.\" class=\"dict\" href=\"query-definitions.html#Query.parameter\"><b>parameter</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..*</b></span> <span style=\"color: darkgreen\"><a href=\"extensibility.html#Extension\">Extension</a></span> <span style=\"color: navy\">Set of query parameters with values</span><span style=\"color: Gray\"> --></span></parameter>\r\n <<a title=\"If this is a response to a query.\" class=\"dict\" href=\"query-definitions.html#Query.response\"><b>response</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> If this is a response to a query --></span>\r\n <<a title=\"Links response to source query.\" class=\"dict\" href=\"query-definitions.html#Query.response.identifier\"><b>identifier</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Links response to source query</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Outcome of processing the query.\" class=\"dict\" href=\"query-definitions.html#Query.response.outcome\"><b>outcome</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"query-outcome.html\">ok | limited | refused | error</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Total number of matching records.\" class=\"dict\" href=\"query-definitions.html#Query.response.total\"><b>total</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Total number of matching records</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Parameters server used.\" class=\"dict\" href=\"query-definitions.html#Query.response.parameter\"><b>parameter</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"extensibility.html#Extension\">Extension</a></span> <span style=\"color: navy\">Parameters server used</span><span style=\"color: Gray\"> --></span></parameter>\r\n <<a title=\"To get first page (if paged).\" class=\"dict\" href=\"query-definitions.html#Query.response.first\"><b>first</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"extensibility.html#Extension\">Extension</a></span> <span style=\"color: navy\">To get first page (if paged)</span><span style=\"color: Gray\"> --></span></first>\r\n <<a title=\"To get previous page (if paged).\" class=\"dict\" href=\"query-definitions.html#Query.response.previous\"><b>previous</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"extensibility.html#Extension\">Extension</a></span> <span style=\"color: navy\">To get previous page (if paged)</span><span style=\"color: Gray\"> --></span></previous>\r\n <<a title=\"To get next page (if paged).\" class=\"dict\" href=\"query-definitions.html#Query.response.next\"><b>next</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"extensibility.html#Extension\">Extension</a></span> <span style=\"color: navy\">To get next page (if paged)</span><span style=\"color: Gray\"> --></span></next>\r\n <<a title=\"To get last page (if paged).\" class=\"dict\" href=\"query-definitions.html#Query.response.last\"><b>last</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"extensibility.html#Extension\">Extension</a></span> <span style=\"color: navy\">To get last page (if paged)</span><span style=\"color: Gray\"> --></span></last>\r\n <<a title=\"Resources that are the results of the search.\" class=\"dict\" href=\"query-definitions.html#Query.response.reference\"><b>reference</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">Resources that are the results of the search</span><span style=\"color: Gray\"> --></span></reference>\r\n </response>\r\n</Query>\r\n</pre></div>"
},
{
"title": "\"questionnaire\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/questionnaire",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/questionnaire.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"A structured set of questions and their answers. The Questionnaire may contain questions, answers or both. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the underlying questions.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire\"><b>Questionnaire</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"The lifecycle status of the questionnaire as a whole (this element modifies the meaning of other elements)\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"questionnaire-status.html\">draft | published | retired | in progress | completed | amended<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The date and/or time that this version of the questionnaire was authored.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.authored\"><b>authored</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Date this version was authored<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The subject of the questionnaires: this is the patient that the answers apply to, but this person is not necessarily the source of information.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"relatedperson.html#RelatedPerson\">RelatedPerson</a>)</span> <span style=\"color: navy\">The subject of the questions<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"Person who received the answers to the questions in the Questionnaire and recorded them in the system.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.author\"><b>author</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"patient.html#Patient\">Patient</a>|<a href=\"relatedperson.html#RelatedPerson\">RelatedPerson</a>)</span> <span style=\"color: navy\">\r\n Person who received and recorded the answers<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></author>\r\n <<a title=\"The person who answered the questions about the subject. Only used when this is not the subject him/herself.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.source\"><b>source</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"relatedperson.html#RelatedPerson\">RelatedPerson</a>)</span> <span style=\"color: navy\">\r\n The person who answered the questions<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></source>\r\n <<a title=\"Structured name for a predefined list of questions this questionnaire is responding to.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.name\"><b>name</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-questionnaire-name.html\">Name/code for a predefined list of questions<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></name>\r\n <<a title=\"This records identifiers associated with this question/answer set that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">External Ids for this questionnaire<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Encounter during which this questionnaire answers were collected. When there were multiple encounters, this is the one considered most relevant to the context of the answers.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.encounter\"><b>encounter</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"encounter.html#Encounter\">Encounter</a>)</span> <span style=\"color: navy\">\r\n Primary encounter during which the answers were collected<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></encounter>\r\n <<a title=\"A group of questions to a possibly similarly grouped set of questions in the questionnaire.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.group\"><b>group</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> Grouped questions --></span>\r\n <<a title=\"Structured name for a section of a predefined list of questions this questionnaire is responding to.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.group.name\"><b>name</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-questionnaire-group-name.html\">Code or name of the section on a questionnaire</a></span><span style=\"color: Gray\"> --></span></name>\r\n <<a title=\"Text that is displayed above the contents of the group.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.group.header\"><b>header</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Text that is displayed above the contents of the group</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Additional text for the group, used for display purposes.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.group.text\"><b>text</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Additional text for the group</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"More specific subject this section's answers are about, details the subject given in Questionnaire.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.group.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">The subject this group's answers are about</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"A sub-group within a group. The ordering of groups within this group is relevant.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.group.group\"><b>group</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-3: Groups may either contain questions or groups but not both\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> <span style=\"color: darkgreen\">Content as for Questionnaire.group</span> <span style=\"color: navy\">Nested questionnaire group</span><span style=\"color: Gray\"> --></span></group>\r\n <<a title=\"Set of questions within this group. The order of questions within the group is relevant.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.group.question\"><b>question</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-3: Groups may either contain questions or groups but not both\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> Questions in this group --></span>\r\n <<a title=\"Structured name for the question that identifies this question within the Questionnaire or Group.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.group.question.name\"><b>name</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: Must supply a name, a question's text or both\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-questionnaire-question-name.html\">Code or name of the question</a></span><span style=\"color: Gray\"> --></span></name>\r\n <<a title=\"Text of the question as it is shown to the user.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.group.question.text\"><b>text</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: Must supply a name, a question's text or both\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Text of the question as it is shown to the user</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Single-valued answer to the question.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.group.question.answer_x_\"><b>answer[x]</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: Must supply either a simple answer, a choice, data or nothing\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#decimal\">decimal</a>|<a href=\"datatypes.html#integer\">integer</a>|<a href=\"datatypes.html#boolean\">boolean</a>|<a href=\"datatypes.html#date\">date</a>|<a href=\"datatypes.html#string\">string</a>|<a href=\"datatypes.html#dateTime\">dateTime</a>|<a href=\"datatypes.html#instant\">instant</a></span> <span style=\"color: navy\">\r\n Single-valued answer to the question</span><span style=\"color: Gray\"> --></span></answer[x]>\r\n <<a title=\"Selections made by the user from the list of options.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.group.question.choice\"><b>choice</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: Must supply either a simple answer, a choice, data or nothing\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Coding\">Coding</a></span> <span style=\"color: navy\">Selected options</span><span style=\"color: Gray\"> --></span></choice>\r\n <<a title=\"Reference to a valueset containing the possible options.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.group.question.options\"><b>options</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"valueset.html#ValueSet\">ValueSet</a>)</span> <span style=\"color: navy\">Valueset containing the possible options</span><span style=\"color: Gray\"> --></span></options>\r\n <<a title=\"Structured answer in the form of a FHIR Resource or datatype.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.group.question.data_x_\"><b>data[x]</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: Must supply either a simple answer, a choice, data or nothing\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#open\">*</a></span> <span style=\"color: navy\">Structured answer</span><span style=\"color: Gray\"> --></span></data[x]>\r\n <<a title=\"The remark contains information about the answer given. This is additional information about the answer the author wishes to convey, but should not be used to contain information that is part of the answer itself.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.group.question.remarks\"><b>remarks</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Remarks about the answer given</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Nested group, containing nested question for this question. The order of groups within the question is relevant.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.group.question.group\"><b>group</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\">Content as for Questionnaire.group</span> <span style=\"color: navy\">Nested questionnaire group</span><span style=\"color: Gray\"> --></span></group>\r\n </question>\r\n </group>\r\n</Questionnaire>\r\n</pre></div>"
},
"name": "questionnaire",
"publisher": "FHIR Project",
"description": "Basic Profile. A structured set of questions and their answers. The Questionnaire may contain questions, answers or both. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the underlying questions.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage The Questionnaire may be a single list of questions, or can be hierarchically organized in groups and sub-groups, each containing questions. Questions may contain and single answer, which can take the form of simple text, numbers, dates or a set of coded choices. \r\n\r\nQuestionnaires cover the need to communicate data originating from forms used in medical history examinations, research questionnaires and sometimes full clinical speciality records. In many systems this data is collected using user-defined screens and forms. Questionnaires record specifics about data capture - exactly what questions were asked, in what order, what choices for answers were, etc. Each of these questions are part of the Questionnaire, and as such the Questionnaire is a separately identifiable Resource, whereas the individual questions are not. \r\n\r\nExamples of Questionnaires include:\r\n\r\n* Past medical history (PMH)\r\n* Family diseases\r\n* Social history\r\n* Research questionnaires\r\n* Quality and evaluation forms\r\nSupport for validation is outside the scope of this Resource, although basic structural features can be defined using the Questionnaire core extensions.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"structure": [
{
"type": "Questionnaire",
"publish": true,
"element": [
{
"path": "Questionnaire",
"definition": {
"short": "A structured set of questions and their answers",
"formal": "A structured set of questions and their answers. The Questionnaire may contain questions, answers or both. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the underlying questions.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Document[moodCode=DEF or EVN]"
}
]
}
},
{
"path": "Questionnaire.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Questionnaire.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Questionnaire.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "Questionnaire.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "Questionnaire.status",
"definition": {
"short": "draft | published | retired | in progress | completed | amended",
"formal": "The lifecycle status of the questionnaire as a whole.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "QuestionnaireStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/questionnaire-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode (also whether there's a revisionControlAct - and possibly mood to distinguish \"in progress\" from \"published)"
}
]
}
},
{
"path": "Questionnaire.authored",
"definition": {
"short": "Date this version was authored",
"formal": "The date and/or time that this version of the questionnaire was authored.",
"comments": "May be different from the update time of the resource itself, because that is the status of the collection and authoring.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
}
]
}
},
{
"path": "Questionnaire.subject",
"definition": {
"short": "The subject of the questions",
"formal": "The subject of the questionnaires: this is the patient that the answers apply to, but this person is not necessarily the source of information.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/RelatedPerson"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
}
]
}
},
{
"path": "Questionnaire.author",
"definition": {
"short": "Person who received and recorded the answers",
"formal": "Person who received the answers to the questions in the Questionnaire and recorded them in the system.",
"comments": "Mapping a subject's answers to multiple choice options and determining what to put in the textual answer is a matter of interpretation.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/RelatedPerson"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
}
]
}
},
{
"path": "Questionnaire.source",
"definition": {
"short": "The person who answered the questions",
"formal": "The person who answered the questions about the subject. Only used when this is not the subject him/herself.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/RelatedPerson"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=INF].role"
}
]
}
},
{
"path": "Questionnaire.name",
"definition": {
"short": "Name/code for a predefined list of questions",
"formal": "Structured name for a predefined list of questions this questionnaire is responding to.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "QuestionnaireName",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/questionnaire-name"
}
},
"mapping": [
{
"identity": "rim",
"map": ".title"
}
]
}
},
{
"path": "Questionnaire.identifier",
"definition": {
"short": "External Ids for this questionnaire",
"formal": "This records identifiers associated with this question/answer set that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
}
},
{
"path": "Questionnaire.encounter",
"definition": {
"short": "Primary encounter during which the answers were collected",
"formal": "Encounter during which this questionnaire answers were collected. When there were multiple encounters, this is the one considered most relevant to the context of the answers.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Encounter"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"
}
]
}
},
{
"path": "Questionnaire.group",
"definition": {
"short": "Grouped questions",
"formal": "A group of questions to a possibly similarly grouped set of questions in the questionnaire.",
"comments": "The Questionnaire itself has one \"root\" group with the actual contents of the Questionnaire.",
"min": 0,
"max": "1",
"constraint": [
{
"key": "3",
"name": "GroupHaveSubOrQuestions",
"severity": "error",
"human": "Groups may either contain questions or groups but not both",
"xpath": "not(exists(f:group) and exists(f:question))"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=DOCSECT, moodCode=EVN]"
}
]
}
},
{
"path": "Questionnaire.group.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Questionnaire.group.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Questionnaire.group.name",
"definition": {
"short": "Code or name of the section on a questionnaire",
"formal": "Structured name for a section of a predefined list of questions this questionnaire is responding to.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "QuestionnaireGroupName",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/questionnaire-group-name"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
}
},
{
"path": "Questionnaire.group.header",
"definition": {
"short": "Text that is displayed above the contents of the group",
"formal": "Text that is displayed above the contents of the group.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".title"
}
]
}
},
{
"path": "Questionnaire.group.text",
"definition": {
"short": "Additional text for the group",
"formal": "Additional text for the group, used for display purposes.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".text"
}
]
}
},
{
"path": "Questionnaire.group.subject",
"definition": {
"short": "The subject this group's answers are about",
"formal": "More specific subject this section's answers are about, details the subject given in Questionnaire.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Any"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role\nor\n.outboundRelationship[typeCode=SUBJ].target"
}
]
}
},
{
"path": "Questionnaire.group.group",
"definition": {
"short": "Nested questionnaire group",
"formal": "A sub-group within a group. The ordering of groups within this group is relevant.",
"min": 0,
"max": "*",
"nameReference": "Questionnaire.group",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=DOCSECT, moodCode=EVN]"
}
]
}
},
{
"path": "Questionnaire.group.question",
"definition": {
"short": "Questions in this group",
"formal": "Set of questions within this group. The order of questions within the group is relevant.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "2",
"name": "MustHaveNameOrText",
"severity": "error",
"human": "Must supply a name, a question's text or both",
"xpath": "count(f:name) + count(f:text) >= 1"
},
{
"key": "1",
"name": "SimpleChoiceOrData",
"severity": "error",
"human": "Must supply either a simple answer, a choice, data or nothing",
"xpath": "count(f:data) + count(f:choice) + count(f:answer) <= 1"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN or DEF]"
}
]
}
},
{
"path": "Questionnaire.group.question.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Questionnaire.group.question.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Questionnaire.group.question.name",
"definition": {
"short": "Code or name of the question",
"formal": "Structured name for the question that identifies this question within the Questionnaire or Group.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "QuestionName",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/questionnaire-question-name"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
}
},
{
"path": "Questionnaire.group.question.text",
"definition": {
"short": "Text of the question as it is shown to the user",
"formal": "Text of the question as it is shown to the user.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".code.display"
}
]
}
},
{
"path": "Questionnaire.group.question.answer[x]",
"definition": {
"short": "Single-valued answer to the question",
"formal": "Single-valued answer to the question.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
},
{
"code": "integer"
},
{
"code": "boolean"
},
{
"code": "date"
},
{
"code": "string"
},
{
"code": "dateTime"
},
{
"code": "instant"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".value"
}
]
}
},
{
"path": "Questionnaire.group.question.choice",
"definition": {
"short": "Selected options",
"formal": "Selections made by the user from the list of options.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Not supported - MIF/templating layer to capture value set"
}
]
}
},
{
"path": "Questionnaire.group.question.options",
"definition": {
"short": "Valueset containing the possible options",
"formal": "Reference to a valueset containing the possible options.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/ValueSet"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Not supported - MIF/templating layer to capture value set"
}
]
}
},
{
"path": "Questionnaire.group.question.data[x]",
"definition": {
"short": "Structured answer",
"formal": "Structured answer in the form of a FHIR Resource or datatype.",
"min": 0,
"max": "1",
"type": [
{
"code": "*"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=VALUE].target"
}
]
}
},
{
"path": "Questionnaire.group.question.remarks",
"definition": {
"short": "Remarks about the answer given",
"formal": "The remark contains information about the answer given. This is additional information about the answer the author wishes to convey, but should not be used to contain information that is part of the answer itself.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}
]
}
},
{
"path": "Questionnaire.group.question.group",
"definition": {
"short": "Nested questionnaire group",
"formal": "Nested group, containing nested question for this question. The order of groups within the question is relevant.",
"min": 0,
"max": "*",
"nameReference": "Questionnaire.group",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=DOCSECT, moodCode=EVN]"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "author",
"type": "reference",
"documentation": "The author of the questionnaire",
"xpath": "f:Questionnaire/f:author"
},
{
"name": "authored",
"type": "date",
"documentation": "When the questionnaire was authored",
"xpath": "f:Questionnaire/f:authored"
},
{
"name": "encounter",
"type": "reference",
"documentation": "Encounter during which questionnaire was authored",
"xpath": "f:Questionnaire/f:encounter"
},
{
"name": "identifier",
"type": "token",
"documentation": "An identifier for the questionnaire",
"xpath": "f:Questionnaire/f:identifier"
},
{
"name": "name",
"type": "token",
"documentation": "Name of the questionnaire",
"xpath": "f:Questionnaire/f:name"
},
{
"name": "status",
"type": "token",
"documentation": "The status of the questionnaire",
"xpath": "f:Questionnaire/f:status"
},
{
"name": "subject",
"type": "reference",
"documentation": "The subject of the questionnaire",
"xpath": "f:Questionnaire/f:subject"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"A structured set of questions and their answers. The Questionnaire may contain questions, answers or both. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the underlying questions.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire\"><b>Questionnaire</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"The lifecycle status of the questionnaire as a whole (this element modifies the meaning of other elements)\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"questionnaire-status.html\">draft | published | retired | in progress | completed | amended<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The date and/or time that this version of the questionnaire was authored.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.authored\"><b>authored</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Date this version was authored<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The subject of the questionnaires: this is the patient that the answers apply to, but this person is not necessarily the source of information.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"relatedperson.html#RelatedPerson\">RelatedPerson</a>)</span> <span style=\"color: navy\">The subject of the questions<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"Person who received the answers to the questions in the Questionnaire and recorded them in the system.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.author\"><b>author</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"patient.html#Patient\">Patient</a>|<a href=\"relatedperson.html#RelatedPerson\">RelatedPerson</a>)</span> <span style=\"color: navy\">\r\n Person who received and recorded the answers<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></author>\r\n <<a title=\"The person who answered the questions about the subject. Only used when this is not the subject him/herself.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.source\"><b>source</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"relatedperson.html#RelatedPerson\">RelatedPerson</a>)</span> <span style=\"color: navy\">\r\n The person who answered the questions<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></source>\r\n <<a title=\"Structured name for a predefined list of questions this questionnaire is responding to.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.name\"><b>name</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-questionnaire-name.html\">Name/code for a predefined list of questions<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></name>\r\n <<a title=\"This records identifiers associated with this question/answer set that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">External Ids for this questionnaire<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Encounter during which this questionnaire answers were collected. When there were multiple encounters, this is the one considered most relevant to the context of the answers.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.encounter\"><b>encounter</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"encounter.html#Encounter\">Encounter</a>)</span> <span style=\"color: navy\">\r\n Primary encounter during which the answers were collected<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></encounter>\r\n <<a title=\"A group of questions to a possibly similarly grouped set of questions in the questionnaire.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.group\"><b>group</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> Grouped questions --></span>\r\n <<a title=\"Structured name for a section of a predefined list of questions this questionnaire is responding to.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.group.name\"><b>name</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-questionnaire-group-name.html\">Code or name of the section on a questionnaire</a></span><span style=\"color: Gray\"> --></span></name>\r\n <<a title=\"Text that is displayed above the contents of the group.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.group.header\"><b>header</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Text that is displayed above the contents of the group</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Additional text for the group, used for display purposes.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.group.text\"><b>text</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Additional text for the group</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"More specific subject this section's answers are about, details the subject given in Questionnaire.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.group.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">The subject this group's answers are about</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"A sub-group within a group. The ordering of groups within this group is relevant.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.group.group\"><b>group</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-3: Groups may either contain questions or groups but not both\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> <span style=\"color: darkgreen\">Content as for Questionnaire.group</span> <span style=\"color: navy\">Nested questionnaire group</span><span style=\"color: Gray\"> --></span></group>\r\n <<a title=\"Set of questions within this group. The order of questions within the group is relevant.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.group.question\"><b>question</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-3: Groups may either contain questions or groups but not both\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> Questions in this group --></span>\r\n <<a title=\"Structured name for the question that identifies this question within the Questionnaire or Group.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.group.question.name\"><b>name</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: Must supply a name, a question's text or both\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-questionnaire-question-name.html\">Code or name of the question</a></span><span style=\"color: Gray\"> --></span></name>\r\n <<a title=\"Text of the question as it is shown to the user.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.group.question.text\"><b>text</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: Must supply a name, a question's text or both\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Text of the question as it is shown to the user</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Single-valued answer to the question.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.group.question.answer_x_\"><b>answer[x]</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: Must supply either a simple answer, a choice, data or nothing\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#decimal\">decimal</a>|<a href=\"datatypes.html#integer\">integer</a>|<a href=\"datatypes.html#boolean\">boolean</a>|<a href=\"datatypes.html#date\">date</a>|<a href=\"datatypes.html#string\">string</a>|<a href=\"datatypes.html#dateTime\">dateTime</a>|<a href=\"datatypes.html#instant\">instant</a></span> <span style=\"color: navy\">\r\n Single-valued answer to the question</span><span style=\"color: Gray\"> --></span></answer[x]>\r\n <<a title=\"Selections made by the user from the list of options.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.group.question.choice\"><b>choice</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: Must supply either a simple answer, a choice, data or nothing\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Coding\">Coding</a></span> <span style=\"color: navy\">Selected options</span><span style=\"color: Gray\"> --></span></choice>\r\n <<a title=\"Reference to a valueset containing the possible options.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.group.question.options\"><b>options</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"valueset.html#ValueSet\">ValueSet</a>)</span> <span style=\"color: navy\">Valueset containing the possible options</span><span style=\"color: Gray\"> --></span></options>\r\n <<a title=\"Structured answer in the form of a FHIR Resource or datatype.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.group.question.data_x_\"><b>data[x]</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: Must supply either a simple answer, a choice, data or nothing\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#open\">*</a></span> <span style=\"color: navy\">Structured answer</span><span style=\"color: Gray\"> --></span></data[x]>\r\n <<a title=\"The remark contains information about the answer given. This is additional information about the answer the author wishes to convey, but should not be used to contain information that is part of the answer itself.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.group.question.remarks\"><b>remarks</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Remarks about the answer given</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Nested group, containing nested question for this question. The order of groups within the question is relevant.\" class=\"dict\" href=\"questionnaire-definitions.html#Questionnaire.group.question.group\"><b>group</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\">Content as for Questionnaire.group</span> <span style=\"color: navy\">Nested questionnaire group</span><span style=\"color: Gray\"> --></span></group>\r\n </question>\r\n </group>\r\n</Questionnaire>\r\n</pre></div>"
},
{
"title": "\"relatedperson\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/relatedperson",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/relatedperson.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.\" class=\"dict\" href=\"relatedperson-definitions.html#RelatedPerson\"><b>RelatedPerson</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Identifier for a person within a particular scope.\" class=\"dict\" href=\"relatedperson-definitions.html#RelatedPerson.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">A Human identifier for this person<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"The patient this person is related to.\" class=\"dict\" href=\"relatedperson-definitions.html#RelatedPerson.patient\"><b>patient</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">The patient this person is related to<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></patient>\r\n <<a title=\"The nature of the relationship between a patient and the related person.\" class=\"dict\" href=\"relatedperson-definitions.html#RelatedPerson.relationship\"><b>relationship</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-relatedperson-relationshiptype.html\">The nature of the relationship<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></relationship>\r\n <<a title=\"A name associated with the person.\" class=\"dict\" href=\"relatedperson-definitions.html#RelatedPerson.name\"><b>name</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#HumanName\">HumanName</a></span> <span style=\"color: navy\">A name associated with the person<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></name>\r\n <<a title=\"A contact detail for the person, e.g. a telephone number or an email address.\" class=\"dict\" href=\"relatedperson-definitions.html#RelatedPerson.telecom\"><b>telecom</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">A contact detail for the person<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></telecom>\r\n <<a title=\"Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.\" class=\"dict\" href=\"relatedperson-definitions.html#RelatedPerson.gender\"><b>gender</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administrative-gender.html\">Gender for administrative purposes<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></gender>\r\n <<a title=\"Address where the related person can be contacted or visited.\" class=\"dict\" href=\"relatedperson-definitions.html#RelatedPerson.address\"><b>address</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Address\">Address</a></span> <span style=\"color: navy\">Address where the related person can be contacted or visited<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></address>\r\n <<a title=\"Image of the person.\" class=\"dict\" href=\"relatedperson-definitions.html#RelatedPerson.photo\"><b>photo</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Attachment\">Attachment</a></span> <span style=\"color: navy\">Image of the person</span><span style=\"color: Gray\"> --></span></photo>\r\n</RelatedPerson>\r\n</pre></div>"
},
"name": "relatedperson",
"publisher": "FHIR Project",
"description": "Basic Profile. Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage RelatedPersons typically have a personal or non-healthcare-specific professional relationship to the patient. A RelatedPerson resource is primarily used for attribution of information, since RelatedPersons are often a source of information about the patient. For keeping information about persons for contact purposes for a patient, use a Patient's Contact element instead. \r\n\r\nExample RelatedPersons are: \r\n\r\n* A patient's wife or husband\r\n* A patient's relatives or friends\r\n* A neighbor bringing a patient to the hospital\r\n* The owner or trainer of a horse\r\n* A patient's attorney or guardian",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "RelatedPerson",
"publish": true,
"element": [
{
"path": "RelatedPerson",
"definition": {
"short": "An person that is related to a patient, but who is not a direct target of care",
"formal": "Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "role"
}
]
}
},
{
"path": "RelatedPerson.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "RelatedPerson.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "RelatedPerson.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "RelatedPerson.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "RelatedPerson.identifier",
"definition": {
"short": "A Human identifier for this person",
"formal": "Identifier for a person within a particular scope.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "id"
},
{
"identity": "v2",
"map": "NK1-33"
}
]
}
},
{
"path": "RelatedPerson.patient",
"definition": {
"short": "The patient this person is related to",
"formal": "The patient this person is related to.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "scoper[classCode=PSN|ANM and determinerCode='INSTANCE']/playedRole[classCode='PAT']/id"
},
{
"identity": "v2",
"map": "PID-3"
}
]
}
},
{
"path": "RelatedPerson.relationship",
"definition": {
"short": "The nature of the relationship",
"formal": "The nature of the relationship between a patient and the related person.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "PatientRelationshipType",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/relatedperson-relationshiptype"
}
},
"mapping": [
{
"identity": "rim",
"map": "code"
},
{
"identity": "v2",
"map": "NK1-3"
}
]
}
},
{
"path": "RelatedPerson.name",
"definition": {
"short": "A name associated with the person",
"formal": "A name associated with the person.",
"min": 0,
"max": "1",
"type": [
{
"code": "HumanName"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "name"
},
{
"identity": "v2",
"map": "NK1-2"
}
]
}
},
{
"path": "RelatedPerson.telecom",
"definition": {
"short": "A contact detail for the person",
"formal": "A contact detail for the person, e.g. a telephone number or an email address.",
"comments": "Person may have multiple ways to be contacted with different uses or applicable periods. \rMay need to have options for contacting the person urgently, and also to help with identification.",
"min": 0,
"max": "*",
"type": [
{
"code": "Contact"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "telecom"
},
{
"identity": "v2",
"map": "NK1-5 / NK1-6 / NK1-40"
}
]
}
},
{
"path": "RelatedPerson.gender",
"definition": {
"short": "Gender for administrative purposes",
"formal": "Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "AdministrativeGender",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/administrative-gender"
}
},
"mapping": [
{
"identity": "rim",
"map": "administrativeGender"
},
{
"identity": "v2",
"map": "NK1-15"
}
]
}
},
{
"path": "RelatedPerson.address",
"definition": {
"short": "Address where the related person can be contacted or visited",
"formal": "Address where the related person can be contacted or visited.",
"min": 0,
"max": "1",
"type": [
{
"code": "Address"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "addr"
},
{
"identity": "v2",
"map": "NK1-4"
}
]
}
},
{
"path": "RelatedPerson.photo",
"definition": {
"short": "Image of the person",
"formal": "Image of the person.",
"min": 0,
"max": "*",
"type": [
{
"code": "Attachment"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "player[classCode='PSN' and determinerCode='INSTANCE']/desc"
},
{
"identity": "v2",
"map": "OBX-5 - needs a profile"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "address",
"type": "string",
"documentation": "An address in any kind of address/part",
"xpath": "f:RelatedPerson/f:address"
},
{
"name": "gender",
"type": "token",
"documentation": "Gender of the person",
"xpath": "f:RelatedPerson/f:gender"
},
{
"name": "identifier",
"type": "token",
"documentation": "A patient Identifier",
"xpath": "f:RelatedPerson/f:identifier"
},
{
"name": "name",
"type": "string",
"documentation": "A portion of name in any name part",
"xpath": "f:RelatedPerson/f:name"
},
{
"name": "patient",
"type": "reference",
"documentation": "The patient this person is related to",
"xpath": "f:RelatedPerson/f:patient"
},
{
"name": "phonetic",
"type": "string",
"documentation": "A portion of name using some kind of phonetic matching algorithm"
},
{
"name": "telecom",
"type": "string",
"documentation": "The value in any kind of contact",
"xpath": "f:RelatedPerson/f:telecom"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.\" class=\"dict\" href=\"relatedperson-definitions.html#RelatedPerson\"><b>RelatedPerson</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Identifier for a person within a particular scope.\" class=\"dict\" href=\"relatedperson-definitions.html#RelatedPerson.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">A Human identifier for this person<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"The patient this person is related to.\" class=\"dict\" href=\"relatedperson-definitions.html#RelatedPerson.patient\"><b>patient</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">The patient this person is related to<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></patient>\r\n <<a title=\"The nature of the relationship between a patient and the related person.\" class=\"dict\" href=\"relatedperson-definitions.html#RelatedPerson.relationship\"><b>relationship</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-relatedperson-relationshiptype.html\">The nature of the relationship<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></relationship>\r\n <<a title=\"A name associated with the person.\" class=\"dict\" href=\"relatedperson-definitions.html#RelatedPerson.name\"><b>name</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#HumanName\">HumanName</a></span> <span style=\"color: navy\">A name associated with the person<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></name>\r\n <<a title=\"A contact detail for the person, e.g. a telephone number or an email address.\" class=\"dict\" href=\"relatedperson-definitions.html#RelatedPerson.telecom\"><b>telecom</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">A contact detail for the person<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></telecom>\r\n <<a title=\"Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.\" class=\"dict\" href=\"relatedperson-definitions.html#RelatedPerson.gender\"><b>gender</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administrative-gender.html\">Gender for administrative purposes<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></gender>\r\n <<a title=\"Address where the related person can be contacted or visited.\" class=\"dict\" href=\"relatedperson-definitions.html#RelatedPerson.address\"><b>address</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Address\">Address</a></span> <span style=\"color: navy\">Address where the related person can be contacted or visited<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></address>\r\n <<a title=\"Image of the person.\" class=\"dict\" href=\"relatedperson-definitions.html#RelatedPerson.photo\"><b>photo</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Attachment\">Attachment</a></span> <span style=\"color: navy\">Image of the person</span><span style=\"color: Gray\"> --></span></photo>\r\n</RelatedPerson>\r\n</pre></div>"
},
{
"title": "\"securityevent\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/securityevent",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/securityevent.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent\"><b>SecurityEvent</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Identifies the name, action type, time, and disposition of the audited event.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.event\"><b>event</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..1</b></span> What was done --></span>\r\n <<a title=\"Identifier for a family of the event.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.event.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-security-event-type.html\">Type/identifier of event</a></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"Identifier for the category of event.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.event.subtype\"><b>subtype</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-security-event-sub-type.html\">More specific type/id for the event</a></span><span style=\"color: Gray\"> --></span></subtype>\r\n <<a title=\"Indicator for type of action performed during the event that generated the audit.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.event.action\"><b>action</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"security-event-action.html\">Type of action performed during the event</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The time when the event occurred on the source.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.event.dateTime\"><b>dateTime</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#instant\">instant</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Time when the event occurred on source</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Indicates whether the event succeeded or failed.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.event.outcome\"><b>outcome</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"security-event-outcome.html\">Whether the event succeeded or failed</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A free text description of the outcome of the event.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.event.outcomeDesc\"><b>outcomeDesc</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Description of the event outcome</span><span style=\"color: Gray\"> --></span>\r\n </event>\r\n <<a title=\"A person, a hardware device or software process.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.participant\"><b>participant</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..*</b></span> A person, a hardware device or software process --></span>\r\n <<a title=\"Specification of the role(s) the user plays when performing the event. Usually the codes used in this element are local codes defined by the role-based access control security system used in the local context.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.participant.role\"><b>role</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-dicm-402-roleid.html\">User roles (e.g. local RBAC codes)</a></span><span style=\"color: Gray\"> --></span></role>\r\n <<a title=\"Direct reference to a resource that identifies the participant.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.participant.reference\"><b>reference</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-3: Either a userId or a reference, but not both\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"patient.html#Patient\">Patient</a>|<a href=\"device.html#Device\">Device</a>)</span> <span style=\"color: navy\">Direct reference to resource</span><span style=\"color: Gray\"> --></span></reference>\r\n <<a title=\"Unique identifier for the user actively participating in the event.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.participant.userId\"><b>userId</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-3: Either a userId or a reference, but not both\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Unique identifier for the user</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Alternative Participant Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g., single sign-on), if available.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.participant.altId\"><b>altId</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Alternative User id e.g. authentication</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Human-meaningful name for the user.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.participant.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Human-meaningful name for the user</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Indicator that the user is or is not the requestor, or initiator, for the event being audited.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.participant.requestor\"><b>requestor</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Whether user is initiator</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Type of media involved. Used when the event is about exporting/importing onto media.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.participant.media\"><b>media</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Coding\">Coding</a></span> <span style=\"color: navy\">Type of media</span><span style=\"color: Gray\"> --></span></media>\r\n <<a title=\"Logical network location for application activity, if the activity has a network location.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.participant.network\"><b>network</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> Logical network location for application activity --></span>\r\n <<a title=\"An identifier for the network access point of the user device for the audit event.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.participant.network.identifier\"><b>identifier</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Identifier for the network access point of the user device</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"An identifier for the type of network access point that originated the audit event.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.participant.network.type\"><b>type</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"network-type.html\">The type of network access point</a></span><span style=\"color: Gray\"> --></span>\r\n </network>\r\n </participant>\r\n <<a title=\"Application systems and processes.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.source\"><b>source</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..1</b></span> Application systems and processes --></span>\r\n <<a title=\"Logical source location within the healthcare enterprise network.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.source.site\"><b>site</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Logical source location within the enterprise</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identifier of the source where the event originated.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.source.identifier\"><b>identifier</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">The id of source where event originated</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Code specifying the type of source where event originated.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.source.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Coding\">Coding</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-security-source-type.html\">The type of source where event originated</a></span><span style=\"color: Gray\"> --></span></type>\r\n </source>\r\n <<a title=\"Specific instances of data or objects that have been accessed.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.object\"><b>object</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Specific instances of data or objects that have been accessed --></span>\r\n <<a title=\"Identifies a specific instance of the participant object. The reference should always be version specific.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.object.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: Either an identifier or a reference, but not both\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Specific instance of object (e.g. versioned)</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Identifies a specific instance of the participant object. The reference should always be version specific.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.object.reference\"><b>reference</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: Either an identifier or a reference, but not both\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">Specific instance of resource (e.g. versioned)</span><span style=\"color: Gray\"> --></span></reference>\r\n <<a title=\"Object type being audited.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.object.type\"><b>type</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"object-type.html\">Object type being audited</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Code representing the functional application role of Participant Object being audited.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.object.role\"><b>role</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"object-role.html\">Functional application role of Object</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identifier for the data life-cycle stage for the participant object.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.object.lifecycle\"><b>lifecycle</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"object-lifecycle.html\">Life-cycle stage for the object</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Denotes policy-defined sensitivity for the Participant Object ID such as VIP, HIV status, mental health status or similar topics.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.object.sensitivity\"><b>sensitivity</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-security-event-sensitivity.html\">Policy-defined sensitivity for the object</a></span><span style=\"color: Gray\"> --></span></sensitivity>\r\n <<a title=\"An instance-specific descriptor of the Participant Object ID audited, such as a person's name.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.object.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: Either a name or a query (or both)\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Instance-specific descriptor for Object</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Text that describes the object in more detail.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.object.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Descriptive text</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The actual query for a query-type participant object.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.object.query\"><b>query</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#base64Binary\">base64Binary</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: Either a name or a query (or both)\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Actual query for object</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Additional Information about the Object.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.object.detail\"><b>detail</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Additional Information about the Object --></span>\r\n <<a title=\"Name of the property.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.object.detail.type\"><b>type</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Name of the property</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Property value.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.object.detail.value\"><b>value</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#base64Binary\">base64Binary</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Property value</span><span style=\"color: Gray\"> --></span>\r\n </detail>\r\n </object>\r\n</SecurityEvent>\r\n</pre></div>"
},
"name": "securityevent",
"publisher": "FHIR Project",
"description": "Basic Profile. A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage The security event is based on the ATNA Audit record definitions, originally from RFC 3881, and now managed by DICOM (see DICOM Part 15 Annex A5). This resource is managed collaboratively between HL7, DICOM, and IHE for the MHD/mHealth initiatives. \r\n\r\nThe primary purpose of this resource is the maintenance of audit log information. However, it can also be used for simple event-based notification or even general indexing of resources stored in a variety of repositories.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "dicom",
"uri": "http://nema.org/dicom",
"name": "DICOM"
}
],
"structure": [
{
"type": "SecurityEvent",
"publish": true,
"element": [
{
"path": "SecurityEvent",
"definition": {
"short": "Event record kept for security purposes",
"formal": "A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.",
"comments": "Based on ATNA (RFC 3881).",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "ControlAct[moodCode=EVN]"
},
{
"identity": "dicom",
"map": "Message"
}
]
}
},
{
"path": "SecurityEvent.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "SecurityEvent.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "SecurityEvent.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "SecurityEvent.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "SecurityEvent.event",
"definition": {
"short": "What was done",
"formal": "Identifies the name, action type, time, and disposition of the audited event.",
"min": 1,
"max": "1",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A (no nesting in v3)"
},
{
"identity": "dicom",
"map": "EventIdentification"
}
]
}
},
{
"path": "SecurityEvent.event.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "SecurityEvent.event.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "SecurityEvent.event.type",
"definition": {
"short": "Type/identifier of event",
"formal": "Identifier for a family of the event.",
"comments": "e.g., a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "SecurityEventType",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/security-event-type"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code (type, subtype and action are pre-coordinated or sent as translations)"
},
{
"identity": "dicom",
"map": "@EventId"
}
]
}
},
{
"path": "SecurityEvent.event.subtype",
"definition": {
"short": "More specific type/id for the event",
"formal": "Identifier for the category of event.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "SecurityEventSubType",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/security-event-sub-type"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code (type, subtype and action are pre-coordinated or sent as translations)"
},
{
"identity": "dicom",
"map": "@EventTypeCode"
}
]
}
},
{
"path": "SecurityEvent.event.action",
"definition": {
"short": "Type of action performed during the event",
"formal": "Indicator for type of action performed during the event that generated the audit.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "SecurityEventAction",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/security-event-action"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code (type, subtype and action are pre-coordinated or sent as translations)"
},
{
"identity": "dicom",
"map": "@EventActionCode"
}
]
}
},
{
"path": "SecurityEvent.event.dateTime",
"definition": {
"short": "Time when the event occurred on source",
"formal": "The time when the event occurred on the source.",
"comments": "In a distributed system, some sort of common time base, e.g., an NTP [RFC1305] server, is a good implementation tactic.",
"min": 1,
"max": "1",
"type": [
{
"code": "instant"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "dicom",
"map": "@EventDateTime"
}
]
}
},
{
"path": "SecurityEvent.event.outcome",
"definition": {
"short": "Whether the event succeeded or failed",
"formal": "Indicates whether the event succeeded or failed.",
"comments": "In some cases a \"success\" may be partial, for example, an incomplete or interrupted transfer of a radiological study. For the purpose of establishing accountability, these distinctions are not relevant.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "SecurityEventOutcome",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/security-event-outcome"
}
},
"mapping": [
{
"identity": "rim",
"map": ".actionNegationInd"
},
{
"identity": "dicom",
"map": "@EventOutcomeIndicator"
}
]
}
},
{
"path": "SecurityEvent.event.outcomeDesc",
"definition": {
"short": "Description of the event outcome",
"formal": "A free text description of the outcome of the event.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=OUT].target.text"
},
{
"identity": "dicom",
"map": "@EventOutcomeDescription"
}
]
}
},
{
"path": "SecurityEvent.participant",
"definition": {
"short": "A person, a hardware device or software process",
"formal": "A person, a hardware device or software process.",
"comments": "There may be more than one user per event, for example, in cases of actions initiated by one user for other users, or in events that involve more than one user, hardware device, or system process. However, only one user may be the initiator/requestor for the event.",
"min": 1,
"max": "*",
"constraint": [
{
"key": "3",
"name": "Participant Identification",
"severity": "error",
"human": "Either a userId or a reference, but not both",
"xpath": "exists(f:userId) != exists(f:reference)"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation"
},
{
"identity": "dicom",
"map": "ActiveParticipant"
}
]
}
},
{
"path": "SecurityEvent.participant.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "SecurityEvent.participant.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "SecurityEvent.participant.role",
"definition": {
"short": "User roles (e.g. local RBAC codes)",
"formal": "Specification of the role(s) the user plays when performing the event. Usually the codes used in this element are local codes defined by the role-based access control security system used in the local context.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "DICOMRoleId",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/dicm-402-roleid"
}
},
"mapping": [
{
"identity": "rim",
"map": ".typeCode and/or .functionCode"
},
{
"identity": "dicom",
"map": "RoleIdCode"
}
]
}
},
{
"path": "SecurityEvent.participant.reference",
"definition": {
"short": "Direct reference to resource",
"formal": "Direct reference to a resource that identifies the participant.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".role"
}
]
}
},
{
"path": "SecurityEvent.participant.userId",
"definition": {
"short": "Unique identifier for the user",
"formal": "Unique identifier for the user actively participating in the event.",
"comments": "a unique value within the Audit Source ID. For node-based authentication -- where only the system hardware or process, but not a human user, is identified -- User ID would be the node name.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "dicom",
"map": "@UserId"
}
]
}
},
{
"path": "SecurityEvent.participant.altId",
"definition": {
"short": "Alternative User id e.g. authentication",
"formal": "Alternative Participant Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g., single sign-on), if available.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id (distinguish id type by root)"
},
{
"identity": "dicom",
"map": "@AlternativeUserId"
}
]
}
},
{
"path": "SecurityEvent.participant.name",
"definition": {
"short": "Human-meaningful name for the user",
"formal": "Human-meaningful name for the user.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".name"
},
{
"identity": "dicom",
"map": "@UserName"
}
]
}
},
{
"path": "SecurityEvent.participant.requestor",
"definition": {
"short": "Whether user is initiator",
"formal": "Indicator that the user is or is not the requestor, or initiator, for the event being audited.",
"comments": "There can only be one initiator. If the initiator is not clear, then do not choose any one participant as the initiator.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "If participation.typeCode was author, then true"
},
{
"identity": "dicom",
"map": "@UserIsRequestor"
}
]
}
},
{
"path": "SecurityEvent.participant.media",
"definition": {
"short": "Type of media",
"formal": "Type of media involved. Used when the event is about exporting/importing onto media.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".player.description.mediaType"
},
{
"identity": "dicom",
"map": "MediaType"
}
]
}
},
{
"path": "SecurityEvent.participant.network",
"definition": {
"short": "Logical network location for application activity",
"formal": "Logical network location for application activity, if the activity has a network location.",
"min": 0,
"max": "1",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".player.description.reference"
}
]
}
},
{
"path": "SecurityEvent.participant.network.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "SecurityEvent.participant.network.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "SecurityEvent.participant.network.identifier",
"definition": {
"short": "Identifier for the network access point of the user device",
"formal": "An identifier for the network access point of the user device for the audit event.",
"comments": "This could be a device id, IP address or some other identifier associated with a device.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "pre-coordinated into URL"
},
{
"identity": "dicom",
"map": "@NetworkAccessPointID"
}
]
}
},
{
"path": "SecurityEvent.participant.network.type",
"definition": {
"short": "The type of network access point",
"formal": "An identifier for the type of network access point that originated the audit event.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "SecurityEventParticipantNetworkType",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/network-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "pre-coordinated into URL"
},
{
"identity": "dicom",
"map": "@NetworkAccessPointTypeCode"
}
]
}
},
{
"path": "SecurityEvent.source",
"definition": {
"short": "Application systems and processes",
"formal": "Application systems and processes.",
"comments": "Since multi-tier, distributed, or composite applications make source identification ambiguous, this collection of fields may repeat for each application or process actively involved in the event. For example, multiple value-sets can identify participating web servers, application processes, and database server threads in an n-tier distributed application. Passive event participants, e.g., low-level network transports, need not be identified.",
"min": 1,
"max": "1",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=INF].role[classCode=ASSIGN].player[classCode=DEV, determinerCode=INSTANCE]"
},
{
"identity": "dicom",
"map": "AuditSourceIdentification"
}
]
}
},
{
"path": "SecurityEvent.source.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "SecurityEvent.source.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "SecurityEvent.source.site",
"definition": {
"short": "Logical source location within the enterprise",
"formal": "Logical source location within the healthcare enterprise network.",
"comments": "a hospital or other provider location within a multi-entity provider group.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".scopedRole[classCode=LOCE].player.desc"
},
{
"identity": "dicom",
"map": "@AuditEnterpriseSiteId"
}
]
}
},
{
"path": "SecurityEvent.source.identifier",
"definition": {
"short": "The id of source where event originated",
"formal": "Identifier of the source where the event originated.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "dicom",
"map": "@AuditSourceId"
}
]
}
},
{
"path": "SecurityEvent.source.type",
"definition": {
"short": "The type of source where event originated",
"formal": "Code specifying the type of source where event originated.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"isModifier": false,
"binding": {
"name": "SecurityEventSourceType",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/security-source-type"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "dicom",
"map": "AuditSourceTypeCode"
}
]
}
},
{
"path": "SecurityEvent.object",
"definition": {
"short": "Specific instances of data or objects that have been accessed",
"formal": "Specific instances of data or objects that have been accessed.",
"comments": "required unless the values for Event Identification, Active Participant Identification, and Audit Source Identification are sufficient to document the entire auditable event. Because events may have more than one participant object, this group can be a repeating set of values.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "2",
"name": "Object Identification",
"severity": "error",
"human": "Either an identifier or a reference, but not both",
"xpath": "exists(f:identifier) != exists(f:reference)"
},
{
"key": "1",
"name": "Object Name",
"severity": "error",
"human": "Either a name or a query (or both)",
"xpath": "not(exists(f:name)) or not(exists(f:query))"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=SUBJ].target\n\nor\n\n.participation[typeCode=SBJ].role"
},
{
"identity": "dicom",
"map": "ParticipantObjectIdentification"
}
]
}
},
{
"path": "SecurityEvent.object.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "SecurityEvent.object.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "SecurityEvent.object.identifier",
"definition": {
"short": "Specific instance of object (e.g. versioned)",
"formal": "Identifies a specific instance of the participant object. The reference should always be version specific.",
"comments": "Identifier details depends on object type.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id.extension"
},
{
"identity": "dicom",
"map": "@ParticipantObjectID"
}
]
}
},
{
"path": "SecurityEvent.object.reference",
"definition": {
"short": "Specific instance of resource (e.g. versioned)",
"formal": "Identifies a specific instance of the participant object. The reference should always be version specific.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Any"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "[self]"
},
{
"identity": "dicom",
"map": "@ParticipantObjectID"
}
]
}
},
{
"path": "SecurityEvent.object.type",
"definition": {
"short": "Object type being audited",
"formal": "Object type being audited.",
"comments": "This value is distinct from the user's role or any user relationship to the participant object.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "SecurityEventObjectType",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/object-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "[self::Act].code\nor\nrole.player.code"
},
{
"identity": "dicom",
"map": "@ParticipantObjectTypeCode"
}
]
}
},
{
"path": "SecurityEvent.object.role",
"definition": {
"short": "Functional application role of Object",
"formal": "Code representing the functional application role of Participant Object being audited.",
"comments": "See RFC 3881 for rules concerning matches between role and type.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "SecurityEventObjectRole",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/object-role"
}
},
"mapping": [
{
"identity": "rim",
"map": "role.code\n(not sure what this would mean for an Act)"
},
{
"identity": "dicom",
"map": "@ParticipantObjectTypeCodeRole"
}
]
}
},
{
"path": "SecurityEvent.object.lifecycle",
"definition": {
"short": "Life-cycle stage for the object",
"formal": "Identifier for the data life-cycle stage for the participant object.",
"comments": "This can be used to provide an audit trail for data, over time, as it passes through the system.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "SecurityEventObjectLifecycle",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/object-lifecycle"
}
},
"mapping": [
{
"identity": "rim",
"map": "target of ObservationEvent[code=\"lifecycle\"].value"
},
{
"identity": "dicom",
"map": "@ParticipantObjectDataLifeCycle"
}
]
}
},
{
"path": "SecurityEvent.object.sensitivity",
"definition": {
"short": "Policy-defined sensitivity for the object",
"formal": "Denotes policy-defined sensitivity for the Participant Object ID such as VIP, HIV status, mental health status or similar topics.",
"comments": "Values from ATNA are institution- and implementation-defined text strings (in sensitivity.text). HL7 defines confidentiality codes for records, documents etc. that can also be used here.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "SecurityEventObjectSensitivity",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/security-event-sensitivity"
}
},
"mapping": [
{
"identity": "rim",
"map": ".confidentialityCode"
},
{
"identity": "dicom",
"map": "@ParticipantObjectSensitivity"
}
]
}
},
{
"path": "SecurityEvent.object.name",
"definition": {
"short": "Instance-specific descriptor for Object",
"formal": "An instance-specific descriptor of the Participant Object ID audited, such as a person's name.",
"comments": "This field may be used in a query/report to identify audit events for a specific person, e.g., where multiple synonymous Participant Object IDs (patient number, medical record number, encounter number, etc.) have been used.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".title"
},
{
"identity": "dicom",
"map": "ParticipantObjectName"
}
]
}
},
{
"path": "SecurityEvent.object.description",
"definition": {
"short": "Descriptive text",
"formal": "Text that describes the object in more detail.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".text"
},
{
"identity": "dicom",
"map": "ParticipantObjectDescription"
}
]
}
},
{
"path": "SecurityEvent.object.query",
"definition": {
"short": "Actual query for object",
"formal": "The actual query for a query-type participant object.",
"min": 0,
"max": "1",
"type": [
{
"code": "base64Binary"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "No mapping"
},
{
"identity": "dicom",
"map": "ParticipantObjectQuery"
}
]
}
},
{
"path": "SecurityEvent.object.detail",
"definition": {
"short": "Additional Information about the Object",
"formal": "Additional Information about the Object.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN]"
},
{
"identity": "dicom",
"map": "ParticipantObjectDetail"
}
]
}
},
{
"path": "SecurityEvent.object.detail.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "SecurityEvent.object.detail.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "SecurityEvent.object.detail.type",
"definition": {
"short": "Name of the property",
"formal": "Name of the property.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "dicom",
"map": "@type"
}
]
}
},
{
"path": "SecurityEvent.object.detail.value",
"definition": {
"short": "Property value",
"formal": "Property value.",
"min": 1,
"max": "1",
"type": [
{
"code": "base64Binary"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".value"
},
{
"identity": "dicom",
"map": "@value"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "action",
"type": "token",
"documentation": "Type of action performed during the event",
"xpath": "f:SecurityEvent/f:event/f:action"
},
{
"name": "address",
"type": "token",
"documentation": "Identifier for the network access point of the user device",
"xpath": "f:SecurityEvent/f:participant/f:network/f:identifier"
},
{
"name": "altid",
"type": "token",
"documentation": "Alternative User id e.g. authentication",
"xpath": "f:SecurityEvent/f:participant/f:altId"
},
{
"name": "date",
"type": "date",
"documentation": "Time when the event occurred on source",
"xpath": "f:SecurityEvent/f:event/f:dateTime"
},
{
"name": "desc",
"type": "string",
"documentation": "Instance-specific descriptor for Object",
"xpath": "f:SecurityEvent/f:object/f:name"
},
{
"name": "identity",
"type": "token",
"documentation": "Specific instance of object (e.g. versioned)",
"xpath": "f:SecurityEvent/f:object/f:identifier"
},
{
"name": "name",
"type": "string",
"documentation": "Human-meaningful name for the user",
"xpath": "f:SecurityEvent/f:participant/f:name"
},
{
"name": "object-type",
"type": "token",
"documentation": "Object type being audited",
"xpath": "f:SecurityEvent/f:object/f:type"
},
{
"name": "patientid",
"type": "token",
"documentation": "The id of the patient (one of multiple kinds of participations)"
},
{
"name": "reference",
"type": "reference",
"documentation": "Specific instance of resource (e.g. versioned)",
"xpath": "f:SecurityEvent/f:object/f:reference"
},
{
"name": "site",
"type": "token",
"documentation": "Logical source location within the enterprise",
"xpath": "f:SecurityEvent/f:source/f:site"
},
{
"name": "source",
"type": "token",
"documentation": "The id of source where event originated",
"xpath": "f:SecurityEvent/f:source/f:identifier"
},
{
"name": "subtype",
"type": "token",
"documentation": "More specific type/id for the event",
"xpath": "f:SecurityEvent/f:event/f:subtype"
},
{
"name": "type",
"type": "token",
"documentation": "Type/identifier of event",
"xpath": "f:SecurityEvent/f:event/f:type"
},
{
"name": "user",
"type": "token",
"documentation": "Unique identifier for the user",
"xpath": "f:SecurityEvent/f:participant/f:userId"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent\"><b>SecurityEvent</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Identifies the name, action type, time, and disposition of the audited event.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.event\"><b>event</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..1</b></span> What was done --></span>\r\n <<a title=\"Identifier for a family of the event.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.event.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-security-event-type.html\">Type/identifier of event</a></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"Identifier for the category of event.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.event.subtype\"><b>subtype</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-security-event-sub-type.html\">More specific type/id for the event</a></span><span style=\"color: Gray\"> --></span></subtype>\r\n <<a title=\"Indicator for type of action performed during the event that generated the audit.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.event.action\"><b>action</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"security-event-action.html\">Type of action performed during the event</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The time when the event occurred on the source.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.event.dateTime\"><b>dateTime</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#instant\">instant</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Time when the event occurred on source</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Indicates whether the event succeeded or failed.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.event.outcome\"><b>outcome</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"security-event-outcome.html\">Whether the event succeeded or failed</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A free text description of the outcome of the event.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.event.outcomeDesc\"><b>outcomeDesc</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Description of the event outcome</span><span style=\"color: Gray\"> --></span>\r\n </event>\r\n <<a title=\"A person, a hardware device or software process.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.participant\"><b>participant</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..*</b></span> A person, a hardware device or software process --></span>\r\n <<a title=\"Specification of the role(s) the user plays when performing the event. Usually the codes used in this element are local codes defined by the role-based access control security system used in the local context.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.participant.role\"><b>role</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-dicm-402-roleid.html\">User roles (e.g. local RBAC codes)</a></span><span style=\"color: Gray\"> --></span></role>\r\n <<a title=\"Direct reference to a resource that identifies the participant.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.participant.reference\"><b>reference</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-3: Either a userId or a reference, but not both\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"patient.html#Patient\">Patient</a>|<a href=\"device.html#Device\">Device</a>)</span> <span style=\"color: navy\">Direct reference to resource</span><span style=\"color: Gray\"> --></span></reference>\r\n <<a title=\"Unique identifier for the user actively participating in the event.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.participant.userId\"><b>userId</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-3: Either a userId or a reference, but not both\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Unique identifier for the user</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Alternative Participant Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g., single sign-on), if available.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.participant.altId\"><b>altId</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Alternative User id e.g. authentication</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Human-meaningful name for the user.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.participant.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Human-meaningful name for the user</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Indicator that the user is or is not the requestor, or initiator, for the event being audited.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.participant.requestor\"><b>requestor</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Whether user is initiator</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Type of media involved. Used when the event is about exporting/importing onto media.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.participant.media\"><b>media</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Coding\">Coding</a></span> <span style=\"color: navy\">Type of media</span><span style=\"color: Gray\"> --></span></media>\r\n <<a title=\"Logical network location for application activity, if the activity has a network location.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.participant.network\"><b>network</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> Logical network location for application activity --></span>\r\n <<a title=\"An identifier for the network access point of the user device for the audit event.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.participant.network.identifier\"><b>identifier</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Identifier for the network access point of the user device</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"An identifier for the type of network access point that originated the audit event.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.participant.network.type\"><b>type</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"network-type.html\">The type of network access point</a></span><span style=\"color: Gray\"> --></span>\r\n </network>\r\n </participant>\r\n <<a title=\"Application systems and processes.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.source\"><b>source</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..1</b></span> Application systems and processes --></span>\r\n <<a title=\"Logical source location within the healthcare enterprise network.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.source.site\"><b>site</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Logical source location within the enterprise</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identifier of the source where the event originated.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.source.identifier\"><b>identifier</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">The id of source where event originated</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Code specifying the type of source where event originated.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.source.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Coding\">Coding</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-security-source-type.html\">The type of source where event originated</a></span><span style=\"color: Gray\"> --></span></type>\r\n </source>\r\n <<a title=\"Specific instances of data or objects that have been accessed.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.object\"><b>object</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Specific instances of data or objects that have been accessed --></span>\r\n <<a title=\"Identifies a specific instance of the participant object. The reference should always be version specific.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.object.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: Either an identifier or a reference, but not both\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Specific instance of object (e.g. versioned)</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Identifies a specific instance of the participant object. The reference should always be version specific.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.object.reference\"><b>reference</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: Either an identifier or a reference, but not both\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">Specific instance of resource (e.g. versioned)</span><span style=\"color: Gray\"> --></span></reference>\r\n <<a title=\"Object type being audited.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.object.type\"><b>type</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"object-type.html\">Object type being audited</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Code representing the functional application role of Participant Object being audited.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.object.role\"><b>role</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"object-role.html\">Functional application role of Object</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identifier for the data life-cycle stage for the participant object.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.object.lifecycle\"><b>lifecycle</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"object-lifecycle.html\">Life-cycle stage for the object</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Denotes policy-defined sensitivity for the Participant Object ID such as VIP, HIV status, mental health status or similar topics.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.object.sensitivity\"><b>sensitivity</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-security-event-sensitivity.html\">Policy-defined sensitivity for the object</a></span><span style=\"color: Gray\"> --></span></sensitivity>\r\n <<a title=\"An instance-specific descriptor of the Participant Object ID audited, such as a person's name.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.object.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: Either a name or a query (or both)\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Instance-specific descriptor for Object</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Text that describes the object in more detail.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.object.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Descriptive text</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The actual query for a query-type participant object.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.object.query\"><b>query</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#base64Binary\">base64Binary</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: Either a name or a query (or both)\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Actual query for object</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Additional Information about the Object.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.object.detail\"><b>detail</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Additional Information about the Object --></span>\r\n <<a title=\"Name of the property.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.object.detail.type\"><b>type</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Name of the property</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Property value.\" class=\"dict\" href=\"securityevent-definitions.html#SecurityEvent.object.detail.value\"><b>value</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#base64Binary\">base64Binary</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Property value</span><span style=\"color: Gray\"> --></span>\r\n </detail>\r\n </object>\r\n</SecurityEvent>\r\n</pre></div>"
},
{
"title": "\"specimen\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/specimen",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/specimen.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"Sample for analysis.\" class=\"dict\" href=\"specimen-definitions.html#Specimen\"><b>Specimen</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Id for specimen.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">External Identifier</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Kind of material that forms the specimen.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v2/0487/index.html\">Kind of material that forms the specimen</a><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"Parent specimen from which the focal specimen was a component.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.source\"><b>source</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Parent of specimen --></span>\r\n <<a title=\"Whether this relationship is to a parent or to a child.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.source.relationship\"><b>relationship</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"hierarchical-relationship-type.html\">parent | child</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The specimen resource that is the target of this relationship.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.source.target\"><b>target</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"specimen.html#Specimen\">Specimen</a>)</span> <span style=\"color: navy\">The subject of the relationship</span><span style=\"color: Gray\"> --></span></target>\r\n </source>\r\n <<a title=\"Where the specimen came from. This may be the patient(s) or from the environment or a device.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"group.html#Group\">Group</a>|<a href=\"device.html#Device\">Device</a>|<a href=\"substance.html#Substance\">Substance</a>)</span> <span style=\"color: navy\">\r\n Where the specimen came from. This may be the patient(s) or from the environment or a device</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.accessionIdentifier\"><b>accessionIdentifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Identifier assigned by the lab</span><span style=\"color: Gray\"> --></span></accessionIdentifier>\r\n <<a title=\"Time when specimen was received for processing or testing.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.receivedTime\"><b>receivedTime</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">The time when specimen was received for processing</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Details concerning the specimen collection.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.collection\"><b>collection</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..1</b></span> Collection details --></span>\r\n <<a title=\"Person who collected the specimen.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.collection.collector\"><b>collector</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">Who collected the specimen</span><span style=\"color: Gray\"> --></span></collector>\r\n <<a title=\"To communicate any details or issues encountered during the specimen collection procedure.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.collection.comment\"><b>comment</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: navy\">Collector comments</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Time when specimen was collected from subject - the physiologically relevant time.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.collection.collected_x_\"><b>collected[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a>|<a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">Collection time</span><span style=\"color: Gray\"> --></span></collected[x]>\r\n <<a title=\"The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.collection.quantity\"><b>quantity</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">The quantity of specimen collected</span><span style=\"color: Gray\"> --></span></quantity>\r\n <<a title=\"A coded value specifying the technique that is used to perform the procedure.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.collection.method\"><b>method</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-specimen-collection-method.html\">Technique used to perform collection</a></span><span style=\"color: Gray\"> --></span></method>\r\n <<a title=\"Anatomical location from which the specimen should be collected (if subject is a patient). This element is not used for environmental specimens.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.collection.sourceSite\"><b>sourceSite</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-body-site.html\">Anatomical collection site</a></span><span style=\"color: Gray\"> --></span></sourceSite>\r\n </collection>\r\n <<a title=\"Details concerning treatment and processing steps for the specimen.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.treatment\"><b>treatment</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Treatment and processing step details --></span>\r\n <<a title=\"Textual description of procedure.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.treatment.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Textual description of procedure</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A coded value specifying the procedure used to process the specimen.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.treatment.procedure\"><b>procedure</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-specimen-treatment-procedure.html\">Indicates the treatment or processing step applied to the specimen</a></span><span style=\"color: Gray\"> --></span></procedure>\r\n <<a title=\"Material used in the processing step.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.treatment.additive\"><b>additive</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"substance.html#Substance\">Substance</a>)</span> <span style=\"color: navy\">Material used in the processing step</span><span style=\"color: Gray\"> --></span></additive>\r\n </treatment>\r\n <<a title=\"The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.container\"><b>container</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Direct container of specimen (tube/slide, etc) --></span>\r\n <<a title=\"Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.container.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Id for the container</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Textual description of the container.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.container.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Textual description of the container</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The type of container associated with the specimen (e.g. slide, aliquot, etc).\" class=\"dict\" href=\"specimen-definitions.html#Specimen.container.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-specimen-container-type.html\">Kind of container directly associated with specimen</a></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"The capacity (volume or other measure) the container may contain.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.container.capacity\"><b>capacity</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">Container volume or size</span><span style=\"color: Gray\"> --></span></capacity>\r\n <<a title=\"The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.container.specimenQuantity\"><b>specimenQuantity</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">Quantity of specimen within container</span><span style=\"color: Gray\"> --></span></specimenQuantity>\r\n <<a title=\"Additive associated with the container.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.container.additive\"><b>additive</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"substance.html#Substance\">Substance</a>)</span> <span style=\"color: navy\">Additive associated with container</span><span style=\"color: Gray\"> --></span></additive>\r\n </container>\r\n</Specimen>\r\n</pre></div>"
},
"name": "specimen",
"publisher": "FHIR Project",
"description": "Basic Profile. Sample for analysis.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage Any material sample:\r\n\r\n* taken from a biological entity, living or dead\r\n* taken from a physical object or the environment\r\nBiospecimen can contain one or more components including but not limited to cellular molecules, cells, tissues, organs, body fluids, embryos, and body excretory products (source: NCIt, modified). \r\n\r\nThe specimen resource covers substances used for diagnostic and environmental testing. The focus of the specimen resource is the process for gathering, maintaining and processing the specimen as well as where the specimen originated. This is distinct from the use of Substance which is only used when these other aspects are not relevant.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "Specimen",
"publish": true,
"element": [
{
"path": "Specimen",
"definition": {
"short": "Sample for analysis",
"formal": "Sample for analysis.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Role[classCode=SPEC]"
}
]
}
},
{
"path": "Specimen.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Specimen.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Specimen.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "Specimen.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "Specimen.identifier",
"definition": {
"short": "External Identifier",
"formal": "Id for specimen.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "v2",
"map": "SPM-2"
}
]
}
},
{
"path": "Specimen.type",
"definition": {
"short": "Kind of material that forms the specimen",
"formal": "Kind of material that forms the specimen.",
"comments": "The type can change the way that a specimen is handled, and drives what kind of analyses can properly be performed on the specimen. It is frequently used in diagnostic work flow decision making systems.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "SpecimenType",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/v2/vs/0487"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "v2",
"map": "SPM-4 and possibly SPM-5"
}
]
}
},
{
"path": "Specimen.source",
"definition": {
"short": "Parent of specimen",
"formal": "Parent specimen from which the focal specimen was a component.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".scoper (if parent)\n.player.scopesRole[classCode=SPEC].player (if child)"
}
]
}
},
{
"path": "Specimen.source.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Specimen.source.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Specimen.source.relationship",
"definition": {
"short": "parent | child",
"formal": "Whether this relationship is to a parent or to a child.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "HierarchicalRelationshipType",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/hierarchical-relationship-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "as above"
},
{
"identity": "v2",
"map": "not explicit in v2.x SPM segment, but can be\nderived as child,if SPM-3 Specimen parent ID is filled in"
}
]
}
},
{
"path": "Specimen.source.target",
"definition": {
"short": "The subject of the relationship",
"formal": "The specimen resource that is the target of this relationship.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Specimen"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "[self]"
}
]
}
},
{
"path": "Specimen.subject",
"definition": {
"short": "Where the specimen came from. This may be the patient(s) or from the environment or a device",
"formal": "Where the specimen came from. This may be the patient(s) or from the environment or a device.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Group"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Substance"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".scoper\n\nor\n\n.scoper.playsRole"
}
]
}
},
{
"path": "Specimen.accessionIdentifier",
"definition": {
"short": "Identifier assigned by the lab",
"formal": "The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].act[classCode=ACSN, moodCode=EVN].id"
},
{
"identity": "v2",
"map": "SPM-30 (v2.7+)"
}
]
}
},
{
"path": "Specimen.receivedTime",
"definition": {
"short": "The time when specimen was received for processing",
"formal": "Time when specimen was received for processing or testing.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].act[code=SPCREC, moodCode=EVN].effectiveTime"
},
{
"identity": "v2",
"map": "SPM-18"
}
]
}
},
{
"path": "Specimen.collection",
"definition": {
"short": "Collection details",
"formal": "Details concerning the specimen collection.",
"min": 1,
"max": "1",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].act[classCode=SPECCOLLECT, moodCode=EVN]"
}
]
}
},
{
"path": "Specimen.collection.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Specimen.collection.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Specimen.collection.collector",
"definition": {
"short": "Who collected the specimen",
"formal": "Person who collected the specimen.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PFM].role"
}
]
}
},
{
"path": "Specimen.collection.comment",
"definition": {
"short": "Collector comments",
"formal": "To communicate any details or issues encountered during the specimen collection procedure.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}
]
}
},
{
"path": "Specimen.collection.collected[x]",
"definition": {
"short": "Collection time",
"formal": "Time when specimen was collected from subject - the physiologically relevant time.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "v2",
"map": "SPM-17"
}
]
}
},
{
"path": "Specimen.collection.quantity",
"definition": {
"short": "The quantity of specimen collected",
"formal": "The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=SPEC].player.quantity"
},
{
"identity": "v2",
"map": "SPM-12"
}
]
}
},
{
"path": "Specimen.collection.method",
"definition": {
"short": "Technique used to perform collection",
"formal": "A coded value specifying the technique that is used to perform the procedure.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "SpecimenCollectionMethod",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/specimen-collection-method"
}
},
"mapping": [
{
"identity": "rim",
"map": ".methodCode"
},
{
"identity": "v2",
"map": "SPM-7"
}
]
}
},
{
"path": "Specimen.collection.sourceSite",
"definition": {
"short": "Anatomical collection site",
"formal": "Anatomical location from which the specimen should be collected (if subject is a patient). This element is not used for environmental specimens.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "BodySite",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/body-site"
}
},
"mapping": [
{
"identity": "rim",
"map": ".approachSiteCode"
},
{
"identity": "v2",
"map": "SPM-8 and SPM-9"
}
]
}
},
{
"path": "Specimen.treatment",
"definition": {
"short": "Treatment and processing step details",
"formal": "Details concerning treatment and processing steps for the specimen.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].act[code=SPCTRT, moodCode=EVN]"
}
]
}
},
{
"path": "Specimen.treatment.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Specimen.treatment.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Specimen.treatment.description",
"definition": {
"short": "Textual description of procedure",
"formal": "Textual description of procedure.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".text"
}
]
}
},
{
"path": "Specimen.treatment.procedure",
"definition": {
"short": "Indicates the treatment or processing step applied to the specimen",
"formal": "A coded value specifying the procedure used to process the specimen.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "SpecimenTreatmentProcedure",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/specimen-treatment-procedure"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
}
},
{
"path": "Specimen.treatment.additive",
"definition": {
"short": "Material used in the processing step",
"formal": "Material used in the processing step.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Substance"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=ADTV].code"
},
{
"identity": "v2",
"map": "SPM-6"
}
]
}
},
{
"path": "Specimen.container",
"definition": {
"short": "Direct container of specimen (tube/slide, etc)",
"formal": "The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".player.scopingRole[classCode=CONT].scoper"
}
]
}
},
{
"path": "Specimen.container.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Specimen.container.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Specimen.container.identifier",
"definition": {
"short": "Id for the container",
"formal": "Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "v2",
"map": "SAC-3"
}
]
}
},
{
"path": "Specimen.container.description",
"definition": {
"short": "Textual description of the container",
"formal": "Textual description of the container.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".desc"
}
]
}
},
{
"path": "Specimen.container.type",
"definition": {
"short": "Kind of container directly associated with specimen",
"formal": "The type of container associated with the specimen (e.g. slide, aliquot, etc).",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "SpecimenContainerType",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/specimen-container-type"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "v2",
"map": "SPM-27"
}
]
}
},
{
"path": "Specimen.container.capacity",
"definition": {
"short": "Container volume or size",
"formal": "The capacity (volume or other measure) the container may contain.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".quantity"
},
{
"identity": "v2",
"map": "one of: SAC 16, SAC17 and SAC 20, or SAC 21 and SAC 20"
}
]
}
},
{
"path": "Specimen.container.specimenQuantity",
"definition": {
"short": "Quantity of specimen within container",
"formal": "The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".playedRole[classCode=CONT].quantity"
},
{
"identity": "v2",
"map": "SAC-23 (value) SAC-24 (units"
}
]
}
},
{
"path": "Specimen.container.additive",
"definition": {
"short": "Additive associated with container",
"formal": "Additive associated with the container.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Substance"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".scopesRole[classCode=ADTV].player"
},
{
"identity": "v2",
"map": "SAC-27"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "subject",
"type": "reference",
"documentation": "The subject of the specimen",
"xpath": "f:Specimen/f:subject"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"Sample for analysis.\" class=\"dict\" href=\"specimen-definitions.html#Specimen\"><b>Specimen</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Id for specimen.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">External Identifier</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Kind of material that forms the specimen.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v2/0487/index.html\">Kind of material that forms the specimen</a><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"Parent specimen from which the focal specimen was a component.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.source\"><b>source</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Parent of specimen --></span>\r\n <<a title=\"Whether this relationship is to a parent or to a child.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.source.relationship\"><b>relationship</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"hierarchical-relationship-type.html\">parent | child</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The specimen resource that is the target of this relationship.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.source.target\"><b>target</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"specimen.html#Specimen\">Specimen</a>)</span> <span style=\"color: navy\">The subject of the relationship</span><span style=\"color: Gray\"> --></span></target>\r\n </source>\r\n <<a title=\"Where the specimen came from. This may be the patient(s) or from the environment or a device.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"group.html#Group\">Group</a>|<a href=\"device.html#Device\">Device</a>|<a href=\"substance.html#Substance\">Substance</a>)</span> <span style=\"color: navy\">\r\n Where the specimen came from. This may be the patient(s) or from the environment or a device</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.accessionIdentifier\"><b>accessionIdentifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Identifier assigned by the lab</span><span style=\"color: Gray\"> --></span></accessionIdentifier>\r\n <<a title=\"Time when specimen was received for processing or testing.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.receivedTime\"><b>receivedTime</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">The time when specimen was received for processing</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Details concerning the specimen collection.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.collection\"><b>collection</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..1</b></span> Collection details --></span>\r\n <<a title=\"Person who collected the specimen.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.collection.collector\"><b>collector</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">Who collected the specimen</span><span style=\"color: Gray\"> --></span></collector>\r\n <<a title=\"To communicate any details or issues encountered during the specimen collection procedure.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.collection.comment\"><b>comment</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: navy\">Collector comments</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Time when specimen was collected from subject - the physiologically relevant time.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.collection.collected_x_\"><b>collected[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a>|<a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">Collection time</span><span style=\"color: Gray\"> --></span></collected[x]>\r\n <<a title=\"The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.collection.quantity\"><b>quantity</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">The quantity of specimen collected</span><span style=\"color: Gray\"> --></span></quantity>\r\n <<a title=\"A coded value specifying the technique that is used to perform the procedure.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.collection.method\"><b>method</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-specimen-collection-method.html\">Technique used to perform collection</a></span><span style=\"color: Gray\"> --></span></method>\r\n <<a title=\"Anatomical location from which the specimen should be collected (if subject is a patient). This element is not used for environmental specimens.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.collection.sourceSite\"><b>sourceSite</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-body-site.html\">Anatomical collection site</a></span><span style=\"color: Gray\"> --></span></sourceSite>\r\n </collection>\r\n <<a title=\"Details concerning treatment and processing steps for the specimen.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.treatment\"><b>treatment</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Treatment and processing step details --></span>\r\n <<a title=\"Textual description of procedure.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.treatment.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Textual description of procedure</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A coded value specifying the procedure used to process the specimen.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.treatment.procedure\"><b>procedure</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-specimen-treatment-procedure.html\">Indicates the treatment or processing step applied to the specimen</a></span><span style=\"color: Gray\"> --></span></procedure>\r\n <<a title=\"Material used in the processing step.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.treatment.additive\"><b>additive</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"substance.html#Substance\">Substance</a>)</span> <span style=\"color: navy\">Material used in the processing step</span><span style=\"color: Gray\"> --></span></additive>\r\n </treatment>\r\n <<a title=\"The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.container\"><b>container</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Direct container of specimen (tube/slide, etc) --></span>\r\n <<a title=\"Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.container.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Id for the container</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Textual description of the container.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.container.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Textual description of the container</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The type of container associated with the specimen (e.g. slide, aliquot, etc).\" class=\"dict\" href=\"specimen-definitions.html#Specimen.container.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-specimen-container-type.html\">Kind of container directly associated with specimen</a></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"The capacity (volume or other measure) the container may contain.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.container.capacity\"><b>capacity</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">Container volume or size</span><span style=\"color: Gray\"> --></span></capacity>\r\n <<a title=\"The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.container.specimenQuantity\"><b>specimenQuantity</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">Quantity of specimen within container</span><span style=\"color: Gray\"> --></span></specimenQuantity>\r\n <<a title=\"Additive associated with the container.\" class=\"dict\" href=\"specimen-definitions.html#Specimen.container.additive\"><b>additive</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"substance.html#Substance\">Substance</a>)</span> <span style=\"color: navy\">Additive associated with container</span><span style=\"color: Gray\"> --></span></additive>\r\n </container>\r\n</Specimen>\r\n</pre></div>"
},
{
"title": "\"substance\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/substance",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/substance.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"A homogeneous material with a definite composition.\" class=\"dict\" href=\"substance-definitions.html#Substance\"><b>Substance</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"A code (or set of codes) that identify this substance.\" class=\"dict\" href=\"substance-definitions.html#Substance.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-substance-type.html\">What kind of substance this is</a></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"A description of the substance - its appearance, handling requirements, and other usage notes.\" class=\"dict\" href=\"substance-definitions.html#Substance.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Textual description of the substance, comments</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.\" class=\"dict\" href=\"substance-definitions.html#Substance.instance\"><b>instance</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> If this describes a specific package/container of the substance --></span>\r\n <<a title=\"Identifier associated with the package/container (usually a label affixed directly).\" class=\"dict\" href=\"substance-definitions.html#Substance.instance.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Identifier of the package/container</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry.\" class=\"dict\" href=\"substance-definitions.html#Substance.instance.expiry\"><b>expiry</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When no longer valid to use</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The amount of the substance.\" class=\"dict\" href=\"substance-definitions.html#Substance.instance.quantity\"><b>quantity</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">Amount of substance in the package</span><span style=\"color: Gray\"> --></span></quantity>\r\n </instance>\r\n <<a title=\"A substance can be composed of other substances.\" class=\"dict\" href=\"substance-definitions.html#Substance.ingredient\"><b>ingredient</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Composition information about the substance --></span>\r\n <<a title=\"The amount of the ingredient in the substance - a concentration ratio.\" class=\"dict\" href=\"substance-definitions.html#Substance.ingredient.quantity\"><b>quantity</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Ratio\">Ratio</a></span> <span style=\"color: navy\">Optional amount (concentration)</span><span style=\"color: Gray\"> --></span></quantity>\r\n <<a title=\"Another substance that is a component of this substance.\" class=\"dict\" href=\"substance-definitions.html#Substance.ingredient.substance\"><b>substance</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"substance.html#Substance\">Substance</a>)</span> <span style=\"color: navy\">A component of the substance</span><span style=\"color: Gray\"> --></span></substance>\r\n </ingredient>\r\n</Substance>\r\n</pre></div>"
},
"name": "substance",
"publisher": "FHIR Project",
"description": "Basic Profile. A homogeneous material with a definite composition.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage This resource allows for a material to be represented. The resource can be used to represent either a kind of a substance - e.g. a formulation commonly used for treating patients, or it can be used to describe a particular package of a known substance (e.g. bottle, jar, packet). \r\n\r\nThe composition of the material can be specified in terms of a mix of other materials, including with precise amounts if required.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"structure": [
{
"type": "Substance",
"publish": true,
"element": [
{
"path": "Substance",
"definition": {
"short": "A homogeneous material with a definite composition",
"formal": "A homogeneous material with a definite composition.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Material"
}
]
}
},
{
"path": "Substance.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Substance.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Substance.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "Substance.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "Substance.type",
"definition": {
"short": "What kind of substance this is",
"formal": "A code (or set of codes) that identify this substance.",
"comments": "This could be a reference to an externally defined code. It could also be a locally assigned code (e.g. a formulary), optionally with translations to the standard drug codes.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "SubstanceType",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/substance-type"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
}
},
{
"path": "Substance.description",
"definition": {
"short": "Textual description of the substance, comments",
"formal": "A description of the substance - its appearance, handling requirements, and other usage notes.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".player.desc"
}
]
}
},
{
"path": "Substance.instance",
"definition": {
"short": "If this describes a specific package/container of the substance",
"formal": "Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.",
"min": 0,
"max": "1",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".player.determinerCode"
}
]
}
},
{
"path": "Substance.instance.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Substance.instance.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Substance.instance.identifier",
"definition": {
"short": "Identifier of the package/container",
"formal": "Identifier associated with the package/container (usually a label affixed directly).",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
}
},
{
"path": "Substance.instance.expiry",
"definition": {
"short": "When no longer valid to use",
"formal": "When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".expiryTime"
}
]
}
},
{
"path": "Substance.instance.quantity",
"definition": {
"short": "Amount of substance in the package",
"formal": "The amount of the substance.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".player.quantity"
}
]
}
},
{
"path": "Substance.ingredient",
"definition": {
"short": "Composition information about the substance",
"formal": "A substance can be composed of other substances.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".player.scopesRole[classCode=INGR]"
}
]
}
},
{
"path": "Substance.ingredient.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Substance.ingredient.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Substance.ingredient.quantity",
"definition": {
"short": "Optional amount (concentration)",
"formal": "The amount of the ingredient in the substance - a concentration ratio.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".quantity"
}
]
}
},
{
"path": "Substance.ingredient.substance",
"definition": {
"short": "A component of the substance",
"formal": "Another substance that is a component of this substance.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Substance"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".player"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "expiry",
"type": "date",
"documentation": "When no longer valid to use",
"xpath": "f:Substance/f:instance/f:expiry"
},
{
"name": "identifier",
"type": "token",
"documentation": "Identifier of the package/container",
"xpath": "f:Substance/f:instance/f:identifier"
},
{
"name": "quantity",
"type": "number",
"documentation": "Amount of substance in the package",
"xpath": "f:Substance/f:instance/f:quantity"
},
{
"name": "substance",
"type": "reference",
"documentation": "A component of the substance",
"xpath": "f:Substance/f:ingredient/f:substance"
},
{
"name": "type",
"type": "token",
"documentation": "The type of the substance",
"xpath": "f:Substance/f:type"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"A homogeneous material with a definite composition.\" class=\"dict\" href=\"substance-definitions.html#Substance\"><b>Substance</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"A code (or set of codes) that identify this substance.\" class=\"dict\" href=\"substance-definitions.html#Substance.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-substance-type.html\">What kind of substance this is</a></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"A description of the substance - its appearance, handling requirements, and other usage notes.\" class=\"dict\" href=\"substance-definitions.html#Substance.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Textual description of the substance, comments</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.\" class=\"dict\" href=\"substance-definitions.html#Substance.instance\"><b>instance</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> If this describes a specific package/container of the substance --></span>\r\n <<a title=\"Identifier associated with the package/container (usually a label affixed directly).\" class=\"dict\" href=\"substance-definitions.html#Substance.instance.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Identifier of the package/container</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry.\" class=\"dict\" href=\"substance-definitions.html#Substance.instance.expiry\"><b>expiry</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When no longer valid to use</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The amount of the substance.\" class=\"dict\" href=\"substance-definitions.html#Substance.instance.quantity\"><b>quantity</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">Amount of substance in the package</span><span style=\"color: Gray\"> --></span></quantity>\r\n </instance>\r\n <<a title=\"A substance can be composed of other substances.\" class=\"dict\" href=\"substance-definitions.html#Substance.ingredient\"><b>ingredient</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Composition information about the substance --></span>\r\n <<a title=\"The amount of the ingredient in the substance - a concentration ratio.\" class=\"dict\" href=\"substance-definitions.html#Substance.ingredient.quantity\"><b>quantity</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Ratio\">Ratio</a></span> <span style=\"color: navy\">Optional amount (concentration)</span><span style=\"color: Gray\"> --></span></quantity>\r\n <<a title=\"Another substance that is a component of this substance.\" class=\"dict\" href=\"substance-definitions.html#Substance.ingredient.substance\"><b>substance</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"substance.html#Substance\">Substance</a>)</span> <span style=\"color: navy\">A component of the substance</span><span style=\"color: Gray\"> --></span></substance>\r\n </ingredient>\r\n</Substance>\r\n</pre></div>"
},
{
"title": "\"supply\" as a profile (to help derivation)",
"id": "http://hl7.org/fhir/profile/supply",
"link": [
{
"rel": "self",
"href": "http://hl7.org/implement/standards/fhir/supply.profile.xml"
}
],
"updated": "2014-09-30T18:08:29.499+10:00",
"published": "2014-09-30T18:08:29.499+10:00",
"author": [
{
"name": "HL7, Inc (FHIR Project)",
"uri": "http://hl7.org/fhir"
}
],
"content": {
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"A supply - a request for something, and provision of what is supplied.\" class=\"dict\" href=\"supply-definitions.html#Supply\"><b>Supply</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.\" class=\"dict\" href=\"supply-definitions.html#Supply.kind\"><b>kind</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-supply-type.html\">The kind of supply (central, non-stock, etc)</a></span><span style=\"color: Gray\"> --></span></kind>\r\n <<a title=\"Unique identifier for this supply request.\" class=\"dict\" href=\"supply-definitions.html#Supply.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Unique identifier</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Status of the supply request.\" class=\"dict\" href=\"supply-definitions.html#Supply.status\"><b>status</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-supply-status.html\">requested | dispensed | received | failed | cancelled</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The item that is requested to be supplied.\" class=\"dict\" href=\"supply-definitions.html#Supply.orderedItem\"><b>orderedItem</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"medication.html#Medication\">Medication</a>|<a href=\"substance.html#Substance\">Substance</a>|<a href=\"device.html#Device\">Device</a>)</span> <span style=\"color: navy\">\r\n Medication, Substance, or Device requested to be supplied</span><span style=\"color: Gray\"> --></span></orderedItem>\r\n <<a title=\"A link to a resource representing the person whom the ordered item is for.\" class=\"dict\" href=\"supply-definitions.html#Supply.patient\"><b>patient</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Patient for whom the item is supplied</span><span style=\"color: Gray\"> --></span></patient>\r\n <<a title=\"Indicates the details of the dispense event such as the days supply and quantity of a supply dispensed.\" class=\"dict\" href=\"supply-definitions.html#Supply.dispense\"><b>dispense</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Supply details --></span>\r\n <<a title=\"Identifier assigned by the dispensing facility when the dispense occurs.\" class=\"dict\" href=\"supply-definitions.html#Supply.dispense.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">External identifier</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"A code specifying the state of the dispense event (this element modifies the meaning of other elements)\" class=\"dict\" href=\"supply-definitions.html#Supply.dispense.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-supply-dispense-status.html\">in progress | dispensed | abandoned</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.\" class=\"dict\" href=\"supply-definitions.html#Supply.dispense.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-supply-item.html\">Category of dispense event</a></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"The amount of supply that has been dispensed. Includes unit of measure.\" class=\"dict\" href=\"supply-definitions.html#Supply.dispense.quantity\"><b>quantity</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">Amount dispensed</span><span style=\"color: Gray\"> --></span></quantity>\r\n <<a title=\"Identifies the medication or substance being dispensed. This is either a link to a resource representing the details of the medication or substance or a simple attribute carrying a code that identifies the medication from a known list of medications.\" class=\"dict\" href=\"supply-definitions.html#Supply.dispense.suppliedItem\"><b>suppliedItem</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"medication.html#Medication\">Medication</a>|<a href=\"substance.html#Substance\">Substance</a>|<a href=\"device.html#Device\">Device</a>)</span> <span style=\"color: navy\">\r\n Medication, Substance, or Device supplied</span><span style=\"color: Gray\"> --></span></suppliedItem>\r\n <<a title=\"The individual responsible for dispensing the medication.\" class=\"dict\" href=\"supply-definitions.html#Supply.dispense.supplier\"><b>supplier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">Dispenser</span><span style=\"color: Gray\"> --></span></supplier>\r\n <<a title=\"The time the dispense event occurred.\" class=\"dict\" href=\"supply-definitions.html#Supply.dispense.whenPrepared\"><b>whenPrepared</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">Dispensing time</span><span style=\"color: Gray\"> --></span></whenPrepared>\r\n <<a title=\"The time the dispensed item was sent or handed to the patient (or agent).\" class=\"dict\" href=\"supply-definitions.html#Supply.dispense.whenHandedOver\"><b>whenHandedOver</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">Handover time</span><span style=\"color: Gray\"> --></span></whenHandedOver>\r\n <<a title=\"Identification of the facility/location where the Supply was shipped to, as part of the dispense event.\" class=\"dict\" href=\"supply-definitions.html#Supply.dispense.destination\"><b>destination</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">Where the Supply was sent</span><span style=\"color: Gray\"> --></span></destination>\r\n <<a title=\"Identifies the person who picked up the Supply.\" class=\"dict\" href=\"supply-definitions.html#Supply.dispense.receiver\"><b>receiver</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">Who collected the Supply</span><span style=\"color: Gray\"> --></span></receiver>\r\n </dispense>\r\n</Supply>\r\n</pre></div>"
},
"name": "supply",
"publisher": "FHIR Project",
"description": "Basic Profile. A supply - a request for something, and provision of what is supplied.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage The scope of the supply resource is for supplies used in the healthcare process. This includes supplies specifically used in the treatment of patients as well as supply movement within an institution (transport a set of supplies from materials management to a service unit (nurse station). This resource does not include the provisioning of transportation services.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"structure": [
{
"type": "Supply",
"publish": true,
"element": [
{
"path": "Supply",
"definition": {
"short": "A supply - request and provision",
"formal": "A supply - a request for something, and provision of what is supplied.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Supply[moodCode=RQO]"
}
]
}
},
{
"path": "Supply.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Supply.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Supply.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "Supply.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "Supply.kind",
"definition": {
"short": "The kind of supply (central, non-stock, etc)",
"formal": "Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "SupplyType",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/supply-type"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
}
},
{
"path": "Supply.identifier",
"definition": {
"short": "Unique identifier",
"formal": "Unique identifier for this supply request.",
"comments": "This is assigned by the orderer, and used to refer to this order in other external standards.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
}
},
{
"path": "Supply.status",
"definition": {
"short": "requested | dispensed | received | failed | cancelled",
"formal": "Status of the supply request.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "SupplyStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/valueset-supply-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode, also existence of fulfillment events"
}
]
}
},
{
"path": "Supply.orderedItem",
"definition": {
"short": "Medication, Substance, or Device requested to be supplied",
"formal": "The item that is requested to be supplied.",
"comments": "Note that there's a difference between a prescription - an instruction to take a medication, along with a (sometimes) implicit supply, and an explicit request to supply, with no explicit instructions.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Medication"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Substance"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PRD].role"
}
]
}
},
{
"path": "Supply.patient",
"definition": {
"short": "Patient for whom the item is supplied",
"formal": "A link to a resource representing the person whom the ordered item is for.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
}
]
}
},
{
"path": "Supply.dispense",
"definition": {
"short": "Supply details",
"formal": "Indicates the details of the dispense event such as the days supply and quantity of a supply dispensed.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=FLFS].source[classCode=SPLY, moodCode=EVN]"
}
]
}
},
{
"path": "Supply.dispense.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Supply.dispense.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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. Applications processing a resource are required to check for modifier extensions.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Supply.dispense.identifier",
"definition": {
"short": "External identifier",
"formal": "Identifier assigned by the dispensing facility when the dispense occurs.",
"comments": "This is assigned by the dispenser, and used to refer to this order in other external standards.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
}
},
{
"path": "Supply.dispense.status",
"definition": {
"short": "in progress | dispensed | abandoned",
"formal": "A code specifying the state of the dispense event.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "SupplyDispenseStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/valueset-supply-dispense-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode, also existence of fulfillment events"
}
]
}
},
{
"path": "Supply.dispense.type",
"definition": {
"short": "Category of dispense event",
"formal": "Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "SupplyItemType",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/supply-item"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
}
},
{
"path": "Supply.dispense.quantity",
"definition": {
"short": "Amount dispensed",
"formal": "The amount of supply that has been dispensed. Includes unit of measure.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".quantity"
}
]
}
},
{
"path": "Supply.dispense.suppliedItem",
"definition": {
"short": "Medication, Substance, or Device supplied",
"formal": "Identifies the medication or substance being dispensed. This is either a link to a resource representing the details of the medication or substance or a simple attribute carrying a code that identifies the medication from a known list of medications.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Medication"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Substance"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PRD].role"
}
]
}
},
{
"path": "Supply.dispense.supplier",
"definition": {
"short": "Dispenser",
"formal": "The individual responsible for dispensing the medication.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PFM].role"
}
]
}
},
{
"path": "Supply.dispense.whenPrepared",
"definition": {
"short": "Dispensing time",
"formal": "The time the dispense event occurred.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime.low"
}
]
}
},
{
"path": "Supply.dispense.whenHandedOver",
"definition": {
"short": "Handover time",
"formal": "The time the dispensed item was sent or handed to the patient (or agent).",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime.high"
}
]
}
},
{
"path": "Supply.dispense.destination",
"definition": {
"short": "Where the Supply was sent",
"formal": "Identification of the facility/location where the Supply was shipped to, as part of the dispense event.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Location"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=DST].role"
}
]
}
},
{
"path": "Supply.dispense.receiver",
"definition": {
"short": "Who collected the Supply",
"formal": "Identifies the person who picked up the Supply.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=RCV].role"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "dispenseid",
"type": "token",
"documentation": "External identifier",
"xpath": "f:Supply/f:dispense/f:identifier"
},
{
"name": "dispensestatus",
"type": "token",
"documentation": "in progress | dispensed | abandoned",
"xpath": "f:Supply/f:dispense/f:status"
},
{
"name": "identifier",
"type": "token",
"documentation": "Unique identifier",
"xpath": "f:Supply/f:identifier"
},
{
"name": "kind",
"type": "token",
"documentation": "The kind of supply (central, non-stock, etc)",
"xpath": "f:Supply/f:kind"
},
{
"name": "patient",
"type": "reference",
"documentation": "Patient for whom the item is supplied",
"xpath": "f:Supply/f:patient"
},
{
"name": "status",
"type": "token",
"documentation": "requested | dispensed | received | failed | cancelled",
"xpath": "f:Supply/f:status"
},
{
"name": "supplier",
"type": "reference",
"documentation": "Dispenser",
"xpath": "f:Supply/f:dispense/f:supplier"
}
]
}
]
},
"summary": "<div><pre>\r\n<<a title=\"A supply - a request for something, and provision of what is supplied.\" class=\"dict\" href=\"supply-definitions.html#Supply\"><b>Supply</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.\" class=\"dict\" href=\"supply-definitions.html#Supply.kind\"><b>kind</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-supply-type.html\">The kind of supply (central, non-stock, etc)</a></span><span style=\"color: Gray\"> --></span></kind>\r\n <<a title=\"Unique identifier for this supply request.\" class=\"dict\" href=\"supply-definitions.html#Supply.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Unique identifier</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Status of the supply request.\" class=\"dict\" href=\"supply-definitions.html#Supply.status\"><b>status</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-supply-status.html\">requested | dispensed | received | failed | cancelled</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The item that is requested to be supplied.\" class=\"dict\" href=\"supply-definitions.html#Supply.orderedItem\"><b>orderedItem</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"medication.html#Medication\">Medication</a>|<a href=\"substance.html#Substance\">Substance</a>|<a href=\"device.html#Device\">Device</a>)</span> <span style=\"color: navy\">\r\n Medication, Substance, or Device requested to be supplied</span><span style=\"color: Gray\"> --></span></orderedItem>\r\n <<a title=\"A link to a resource representing the person whom the ordered item is for.\" class=\"dict\" href=\"supply-definitions.html#Supply.patient\"><b>patient</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Patient for whom the item is supplied</span><span style=\"color: Gray\"> --></span></patient>\r\n <<a title=\"Indicates the details of the dispense event such as the days supply and quantity of a supply dispensed.\" class=\"dict\" href=\"supply-definitions.html#Supply.dispense\"><b>dispense</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Supply details --></span>\r\n <<a title=\"Identifier assigned by the dispensing facility when the dispense occurs.\" class=\"dict\" href=\"supply-definitions.html#Supply.dispense.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">External identifier</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"A code specifying the state of the dispense event (this element modifies the meaning of other elements)\" class=\"dict\" href=\"supply-definitions.html#Supply.dispense.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-supply-dispense-status.html\">in progress | dispensed | abandoned</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.\" class=\"dict\" href=\"supply-definitions.html#Supply.dispense.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-supply-item.html\">Category of dispense event</a></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"The amount of supply that has been dispensed. Includes unit of measure.\" class=\"dict\" href=\"supply-definitions.html#Supply.dispense.quantity\"><b>quantity</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">Amount dispensed</span><span style=\"color: Gray\"> --></span></quantity>\r\n <<a title=\"Identifies the medication or substance being dispensed. This is either a link to a resource representing the details of the medication or substance or a simple attribute carrying a code that identifies the medication from a known list of medications.\" class=\"dict\" href=\"supply-definitions.html#Supply.dispense.suppliedItem\"><b>suppliedItem</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"medication.html#Medication\">Medication</a>|<a href=\"substance.html#Substance\">Substance</a>|<a href=\"device.html#Device\">Device</a>)</span> <span style=\"color: navy\">\r\n Medication, Substance, or Device supplied</span><span style=\"color: Gray\"> --></span></suppliedItem>\r\n <<a title=\"The individual responsible for dispensing the medication.\" class=\"dict\" href=\"supply-definitions.html#Supply.dispense.supplier\"><b>supplier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">Dispenser</span><span style=\"color: Gray\"> --></span></supplier>\r\n <<a title=\"The time the dispense event occurred.\" class=\"dict\" href=\"supply-definitions.html#Supply.dispense.whenPrepared\"><b>whenPrepared</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">Dispensing time</span><span style=\"color: Gray\"> --></span></whenPrepared>\r\n <<a title=\"The time the dispensed item was sent or handed to the patient (or agent).\" class=\"dict\" href=\"supply-definitions.html#Supply.dispense.whenHandedOver\"><b>whenHandedOver</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">Handover time</span><span style=\"color: Gray\"> --></span></whenHandedOver>\r\n <<a title=\"Identification of the facility/location where the Supply was shipped to, as part of the dispense event.\" class=\"dict\" href=\"supply-definitions.html#Supply.dispense.destination\"><b>destination</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">Where the Supply was sent</span><span style=\"color: Gray\"> --></span></destination>\r\n <<a title=\"Identifies the person who picked up the Supply.\" class=\"dict\" href=\"supply-definitions.html#Supply.dispense.receiver\"><b>receiver</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">Who collected the Supply</span><span style=\"color: Gray\"> --></span></receiver>\r\n </dispense>\r\n</Supply>\r\n</pre></div>"
}
]
}
© HL7.org 2011+. FHIR DSTU (v0.0.82.2943) generated on Tue, Sep 30, 2014 18:10+1000.
Links:
What's a DSTU? |
Version History |
|
Propose a change