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)
<feed xmlns="http://www.w3.org/2005/Atom"> <title>Resources as Profiles</title> <id>http://hl7.org/fhir/profile/resources</id> <link href="http://hl7.org/implement/standards/fhir/profiles-resources.xml" rel="self"/> <updated>2014-09-30T18:09:12.096+10:00</updated> <entry> <title>"conformance-base" - to help with system development</title> <id>http://hl7.org/fhir/conformance/conformance-base</id> <link href="http://hl7.org/implement/standards/fhir/conformance/conformance-base" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Conformance xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><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> </text> <identifier value="http://hl7.org/fhir/conformance-base"/> <version value="0.0.82.2943"/> <name value="Base FHIR Conformance Statement (Full)"/> <publisher value="FHIR Project Team"/> <telecom> <system value="url"/> <value value="http://hl7.org/fhir"/> </telecom> <description value="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 value="draft"/> <date value="2014-09-30T18:08:29.499+10:00"/> <fhirVersion value="0.0.82"/> <acceptUnknown value="false"/> <format value="xml"/> <format value="json"/> <rest> <mode value="server"/> <documentation value="All the functionality defined in FHIR"/> <resource> <type value="AdverseReaction"/> <profile> <reference value="http://hl7.org/fhir/AdverseReaction"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="substance"/> <definition value="http://hl7.org/fhir/profiles/AdverseReaction"/> <type value="reference"/> <documentation value="The name or code of the substance that produces the sensitivity"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/AdverseReaction"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/AdverseReaction"/> <type value="reference"/> <documentation value="The subject that the sensitivity is about"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/AdverseReaction"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/AdverseReaction"/> <type value="date"/> <documentation value="The date of the reaction"/> </searchParam> <searchParam> <name value="symptom"/> <definition value="http://hl7.org/fhir/profiles/AdverseReaction"/> <type value="token"/> <documentation value="One of the symptoms of the reaction"/> </searchParam> </resource> <resource> <type value="Alert"/> <profile> <reference value="http://hl7.org/fhir/Alert"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Alert"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/Alert"/> <type value="reference"/> <documentation value="The identity of a subject to list alerts for"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Alert"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> </resource> <resource> <type value="AllergyIntolerance"/> <profile> <reference value="http://hl7.org/fhir/AllergyIntolerance"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="substance"/> <definition value="http://hl7.org/fhir/profiles/AllergyIntolerance"/> <type value="reference"/> <documentation value="The name or code of the substance that produces the sensitivity"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/AllergyIntolerance"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/AllergyIntolerance"/> <type value="token"/> <documentation value="The status of the sensitivity"/> </searchParam> <searchParam> <name value="recorder"/> <definition value="http://hl7.org/fhir/profiles/AllergyIntolerance"/> <type value="reference"/> <documentation value="Who recorded the sensitivity"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/AllergyIntolerance"/> <type value="reference"/> <documentation value="The subject that the sensitivity is about"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/AllergyIntolerance"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/AllergyIntolerance"/> <type value="date"/> <documentation value="Recorded date/time."/> </searchParam> <searchParam> <name value="type"/> <definition value="http://hl7.org/fhir/profiles/AllergyIntolerance"/> <type value="token"/> <documentation value="The type of sensitivity"/> </searchParam> </resource> <resource> <type value="CarePlan"/> <profile> <reference value="http://hl7.org/fhir/CarePlan"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="activitycode"/> <definition value="http://hl7.org/fhir/profiles/CarePlan"/> <type value="token"/> <documentation value="Detail type of activity"/> </searchParam> <searchParam> <name value="patient"/> <definition value="http://hl7.org/fhir/profiles/CarePlan"/> <type value="reference"/> <documentation value="Who care plan is for"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/CarePlan"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="condition"/> <definition value="http://hl7.org/fhir/profiles/CarePlan"/> <type value="reference"/> <documentation value="Health issues this plan addresses"/> </searchParam> <searchParam> <name value="activitydetail"/> <definition value="http://hl7.org/fhir/profiles/CarePlan"/> <type value="reference"/> <documentation value="Activity details defined in specific resource"/> </searchParam> <searchParam> <name value="activitydate"/> <definition value="http://hl7.org/fhir/profiles/CarePlan"/> <type value="date"/> <documentation value="Specified date occurs within period specified by CarePlan.activity.timingSchedule"/> </searchParam> <searchParam> <name value="participant"/> <definition value="http://hl7.org/fhir/profiles/CarePlan"/> <type value="reference"/> <documentation value="Who is involved"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/CarePlan"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/CarePlan"/> <type value="date"/> <documentation value="Time period plan covers"/> </searchParam> </resource> <resource> <type value="Composition"/> <profile> <reference value="http://hl7.org/fhir/Composition"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="author"/> <definition value="http://hl7.org/fhir/profiles/Composition"/> <type value="reference"/> <documentation value="Who and/or what authored the composition"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Composition"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="attester"/> <definition value="http://hl7.org/fhir/profiles/Composition"/> <type value="reference"/> <documentation value="Who attested the composition"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/Composition"/> <type value="reference"/> <documentation value="Who and/or what the composition is about"/> </searchParam> <searchParam> <name value="section-content"/> <definition value="http://hl7.org/fhir/profiles/Composition"/> <type value="reference"/> <documentation value="The actual data for the section"/> </searchParam> <searchParam> <name value="context"/> <definition value="http://hl7.org/fhir/profiles/Composition"/> <type value="token"/> <documentation value="Code(s) that apply to the event being documented"/> </searchParam> <searchParam> <name value="class"/> <definition value="http://hl7.org/fhir/profiles/Composition"/> <type value="token"/> <documentation value="Categorization of Composition"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Composition"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="section-type"/> <definition value="http://hl7.org/fhir/profiles/Composition"/> <type value="token"/> <documentation value="Classification of section (recommended)"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/Composition"/> <type value="date"/> <documentation value="Composition editing time"/> </searchParam> <searchParam> <name value="type"/> <definition value="http://hl7.org/fhir/profiles/Composition"/> <type value="token"/> <documentation value="Kind of composition (LOINC if possible)"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/Composition"/> <type value="token"/> <documentation value="Logical identifier of composition (version-independent)"/> </searchParam> </resource> <resource> <type value="ConceptMap"/> <profile> <reference value="http://hl7.org/fhir/ConceptMap"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="dependson"/> <definition value="http://hl7.org/fhir/profiles/ConceptMap"/> <type value="token"/> <documentation value="Reference to element/field/valueset provides the context"/> </searchParam> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/ConceptMap"/> <type value="token"/> <documentation value="Status of the concept map"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/ConceptMap"/> <type value="date"/> <documentation value="The concept map publication date"/> </searchParam> <searchParam> <name value="version"/> <definition value="http://hl7.org/fhir/profiles/ConceptMap"/> <type value="token"/> <documentation value="The version identifier of the concept map"/> </searchParam> <searchParam> <name value="publisher"/> <definition value="http://hl7.org/fhir/profiles/ConceptMap"/> <type value="string"/> <documentation value="Name of the publisher of the concept map"/> </searchParam> <searchParam> <name value="product"/> <definition value="http://hl7.org/fhir/profiles/ConceptMap"/> <type value="token"/> <documentation value="Reference to element/field/valueset provides the context"/> </searchParam> <searchParam> <name value="system"/> <definition value="http://hl7.org/fhir/profiles/ConceptMap"/> <type value="token"/> <documentation value="The system for any destination concepts mapped by this map"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/ConceptMap"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="source"/> <definition value="http://hl7.org/fhir/profiles/ConceptMap"/> <type value="reference"/> <documentation value="The system for any concepts mapped by this concept map"/> </searchParam> <searchParam> <name value="description"/> <definition value="http://hl7.org/fhir/profiles/ConceptMap"/> <type value="string"/> <documentation value="Text search in the description of the concept map"/> </searchParam> <searchParam> <name value="name"/> <definition value="http://hl7.org/fhir/profiles/ConceptMap"/> <type value="string"/> <documentation value="Name of the concept map"/> </searchParam> <searchParam> <name value="target"/> <definition value="http://hl7.org/fhir/profiles/ConceptMap"/> <type value="reference"/> <documentation value="Provides context to the mappings"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/ConceptMap"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/ConceptMap"/> <type value="token"/> <documentation value="The identifier of the concept map"/> </searchParam> </resource> <resource> <type value="Condition"/> <profile> <reference value="http://hl7.org/fhir/Condition"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="asserter"/> <definition value="http://hl7.org/fhir/profiles/Condition"/> <type value="reference"/> <documentation value="Person who asserts this condition"/> </searchParam> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/Condition"/> <type value="token"/> <documentation value="The status of the condition"/> </searchParam> <searchParam> <name value="location"/> <definition value="http://hl7.org/fhir/profiles/Condition"/> <type value="token"/> <documentation value="Location - may include laterality"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/Condition"/> <type value="reference"/> <documentation value="Who has the condition?"/> </searchParam> <searchParam> <name value="onset"/> <definition value="http://hl7.org/fhir/profiles/Condition"/> <type value="date"/> <documentation value="When the Condition started (if started on a date)"/> </searchParam> <searchParam> <name value="evidence"/> <definition value="http://hl7.org/fhir/profiles/Condition"/> <type value="token"/> <documentation value="Manifestation/symptom"/> </searchParam> <searchParam> <name value="severity"/> <definition value="http://hl7.org/fhir/profiles/Condition"/> <type value="token"/> <documentation value="The severity of the condition"/> </searchParam> <searchParam> <name value="code"/> <definition value="http://hl7.org/fhir/profiles/Condition"/> <type value="token"/> <documentation value="Code for the condition"/> </searchParam> <searchParam> <name value="encounter"/> <definition value="http://hl7.org/fhir/profiles/Condition"/> <type value="reference"/> <documentation value="Encounter when condition first asserted"/> </searchParam> <searchParam> <name value="date-asserted"/> <definition value="http://hl7.org/fhir/profiles/Condition"/> <type value="date"/> <documentation value="When first detected/suspected/entered"/> </searchParam> <searchParam> <name value="stage"/> <definition value="http://hl7.org/fhir/profiles/Condition"/> <type value="token"/> <documentation value="Simple summary (disease specific)"/> </searchParam> <searchParam> <name value="related-code"/> <definition value="http://hl7.org/fhir/profiles/Condition"/> <type value="token"/> <documentation value="Relationship target by means of a predefined code"/> </searchParam> <searchParam> <name value="category"/> <definition value="http://hl7.org/fhir/profiles/Condition"/> <type value="token"/> <documentation value="The category of the condition"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Condition"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="related-item"/> <definition value="http://hl7.org/fhir/profiles/Condition"/> <type value="reference"/> <documentation value="Relationship target resource"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Condition"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> </resource> <resource> <type value="Conformance"/> <profile> <reference value="http://hl7.org/fhir/Conformance"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="token"/> <documentation value="The current status of the conformance statement"/> </searchParam> <searchParam> <name value="resource"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="token"/> <documentation value="Name of a resource mentioned in a conformance statement"/> </searchParam> <searchParam> <name value="security"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="token"/> <documentation value="Information about security of implementation"/> </searchParam> <searchParam> <name value="format"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="token"/> <documentation value="formats supported (xml | json | mime type)"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="date"/> <documentation value="The conformance statement publication date"/> </searchParam> <searchParam> <name value="mode"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="token"/> <documentation value="Mode - restful (server/client) or messaging (sender/receiver)"/> </searchParam> <searchParam> <name value="version"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="token"/> <documentation value="The version identifier of the conformance statement"/> </searchParam> <searchParam> <name value="publisher"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="string"/> <documentation value="Name of the publisher of the conformance statement"/> </searchParam> <searchParam> <name value="software"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="string"/> <documentation value="Part of a the name of a software application"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="description"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="string"/> <documentation value="Text search in the description of the conformance statement"/> </searchParam> <searchParam> <name value="event"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="token"/> <documentation value="Event code in a conformance statement"/> </searchParam> <searchParam> <name value="name"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="string"/> <documentation value="Name of the conformance statement"/> </searchParam> <searchParam> <name value="supported-profile"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="reference"/> <documentation value="Profiles supported by the system"/> </searchParam> <searchParam> <name value="fhirversion"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="token"/> <documentation value="The version of FHIR"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="token"/> <documentation value="The identifier of the conformance statement"/> </searchParam> <searchParam> <name value="profile"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="reference"/> <documentation value="A profile id invoked in a conformance statement"/> </searchParam> </resource> <resource> <type value="Device"/> <profile> <reference value="http://hl7.org/fhir/Device"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="organization"/> <definition value="http://hl7.org/fhir/profiles/Device"/> <type value="reference"/> <documentation value="The organization responsible for the device"/> </searchParam> <searchParam> <name value="model"/> <definition value="http://hl7.org/fhir/profiles/Device"/> <type value="string"/> <documentation value="The model of the device"/> </searchParam> <searchParam> <name value="patient"/> <definition value="http://hl7.org/fhir/profiles/Device"/> <type value="reference"/> <documentation value="Patient information, if the resource is affixed to a person"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Device"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="location"/> <definition value="http://hl7.org/fhir/profiles/Device"/> <type value="reference"/> <documentation value="A location, where the resource is found"/> </searchParam> <searchParam> <name value="manufacturer"/> <definition value="http://hl7.org/fhir/profiles/Device"/> <type value="string"/> <documentation value="The manufacturer of the device"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Device"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="udi"/> <definition value="http://hl7.org/fhir/profiles/Device"/> <type value="string"/> <documentation value="FDA Mandated Unique Device Identifier"/> </searchParam> <searchParam> <name value="type"/> <definition value="http://hl7.org/fhir/profiles/Device"/> <type value="token"/> <documentation value="The type of the device"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/Device"/> <type value="token"/> <documentation value="Instance id from manufacturer, owner and others"/> </searchParam> </resource> <resource> <type value="DeviceObservationReport"/> <profile> <reference value="http://hl7.org/fhir/DeviceObservationReport"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="observation"/> <definition value="http://hl7.org/fhir/profiles/DeviceObservationReport"/> <type value="reference"/> <documentation value="The data for the metric"/> </searchParam> <searchParam> <name value="source"/> <definition value="http://hl7.org/fhir/profiles/DeviceObservationReport"/> <type value="reference"/> <documentation value="Identifies/describes where the data came from"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/DeviceObservationReport"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/DeviceObservationReport"/> <type value="reference"/> <documentation value="Subject of the measurement"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/DeviceObservationReport"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="code"/> <definition value="http://hl7.org/fhir/profiles/DeviceObservationReport"/> <type value="token"/> <documentation value="The compatment code"/> </searchParam> <searchParam> <name value="channel"/> <definition value="http://hl7.org/fhir/profiles/DeviceObservationReport"/> <type value="token"/> <documentation value="The channel code"/> </searchParam> </resource> <resource> <type value="DiagnosticOrder"/> <profile> <reference value="http://hl7.org/fhir/DiagnosticOrder"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="orderer"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="reference"/> <documentation value="Who ordered the test"/> </searchParam> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="token"/> <documentation value="requested | received | accepted | in progress | review | completed | suspended | rejected | failed"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="reference"/> <documentation value="Who and/or what test is about"/> </searchParam> <searchParam> <name value="item-status"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="token"/> <documentation value="requested | received | accepted | in progress | review | completed | suspended | rejected | failed"/> </searchParam> <searchParam> <name value="event-status"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="token"/> <documentation value="requested | received | accepted | in progress | review | completed | suspended | rejected | failed"/> </searchParam> <searchParam> <name value="actor"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="reference"/> <documentation value="Who recorded or did this"/> </searchParam> <searchParam> <name value="code"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="token"/> <documentation value="Code to indicate the item (test or panel) being ordered"/> </searchParam> <searchParam> <name value="encounter"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="reference"/> <documentation value="The encounter that this diagnostic order is associated with"/> </searchParam> <searchParam> <name value="item-past-status"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="token"/> <documentation value="requested | received | accepted | in progress | review | completed | suspended | rejected | failed"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="bodysite"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="token"/> <documentation value="Location of requested test (if applicable)"/> </searchParam> <searchParam> <name value="item-date"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="date"/> <documentation value="The date at which the event happened"/> </searchParam> <searchParam> <name value="specimen"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="reference"/> <documentation value="If the whole order relates to specific specimens"/> </searchParam> <searchParam> <name value="event-status-date"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="composite"/> <documentation value="A combination of past-status and date"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="event-date"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="date"/> <documentation value="The date at which the event happened"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="token"/> <documentation value="Identifiers assigned to this order"/> </searchParam> <searchParam> <name value="item-status-date"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="composite"/> <documentation value="A combination of item-past-status and item-date"/> </searchParam> </resource> <resource> <type value="DiagnosticReport"/> <profile> <reference value="http://hl7.org/fhir/DiagnosticReport"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="result"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticReport"/> <type value="reference"/> <documentation value="Link to an atomic result (observation resource)"/> </searchParam> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticReport"/> <type value="token"/> <documentation value="The status of the report"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticReport"/> <type value="reference"/> <documentation value="The subject of the report"/> </searchParam> <searchParam> <name value="issued"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticReport"/> <type value="date"/> <documentation value="When the report was issued"/> </searchParam> <searchParam> <name value="diagnosis"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticReport"/> <type value="token"/> <documentation value="A coded diagnosis on the report"/> </searchParam> <searchParam> <name value="image"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticReport"/> <type value="reference"/> <documentation value="Reference to the image source"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticReport"/> <type value="date"/> <documentation value="The clinically relevant time of the report"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticReport"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="request"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticReport"/> <type value="reference"/> <documentation value="What was requested"/> </searchParam> <searchParam> <name value="specimen"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticReport"/> <type value="reference"/> <documentation value="The specimen details"/> </searchParam> <searchParam> <name value="name"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticReport"/> <type value="token"/> <documentation value="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)"/> </searchParam> <searchParam> <name value="service"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticReport"/> <type value="token"/> <documentation value="Which diagnostic discipline/department created the report"/> </searchParam> <searchParam> <name value="performer"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticReport"/> <type value="reference"/> <documentation value="Who was the source of the report (organization)"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticReport"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticReport"/> <type value="token"/> <documentation value="An identifier for the report"/> </searchParam> </resource> <resource> <type value="DocumentManifest"/> <profile> <reference value="http://hl7.org/fhir/DocumentManifest"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="supersedes"/> <definition value="http://hl7.org/fhir/profiles/DocumentManifest"/> <type value="reference"/> <documentation value="If this document manifest replaces another"/> </searchParam> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/DocumentManifest"/> <type value="token"/> <documentation value="current | superceded | entered in error"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/DocumentManifest"/> <type value="reference"/> <documentation value="The subject of the set of documents"/> </searchParam> <searchParam> <name value="type"/> <definition value="http://hl7.org/fhir/profiles/DocumentManifest"/> <type value="token"/> <documentation value="What kind of document set this is"/> </searchParam> <searchParam> <name value="recipient"/> <definition value="http://hl7.org/fhir/profiles/DocumentManifest"/> <type value="reference"/> <documentation value="Intended to get notified about this set of documents"/> </searchParam> <searchParam> <name value="content"/> <definition value="http://hl7.org/fhir/profiles/DocumentManifest"/> <type value="reference"/> <documentation value="Contents of this set of documents"/> </searchParam> <searchParam> <name value="author"/> <definition value="http://hl7.org/fhir/profiles/DocumentManifest"/> <type value="reference"/> <documentation value="Who and/or what authored the document"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/DocumentManifest"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="created"/> <definition value="http://hl7.org/fhir/profiles/DocumentManifest"/> <type value="date"/> <documentation value="When this document manifest created"/> </searchParam> <searchParam> <name value="description"/> <definition value="http://hl7.org/fhir/profiles/DocumentManifest"/> <type value="string"/> <documentation value="Human-readable description (title)"/> </searchParam> <searchParam> <name value="confidentiality"/> <definition value="http://hl7.org/fhir/profiles/DocumentManifest"/> <type value="token"/> <documentation value="Sensitivity of set of documents"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/DocumentManifest"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/DocumentManifest"/> <type value="token"/> <documentation value="Unique Identifier for the set of documents"/> </searchParam> </resource> <resource> <type value="DocumentReference"/> <profile> <reference value="http://hl7.org/fhir/DocumentReference"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="location"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="string"/> <documentation value="Where to access the document"/> </searchParam> <searchParam> <name value="indexed"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="date"/> <documentation value="When this document reference created"/> </searchParam> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="token"/> <documentation value="current | superceded | entered in error"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="reference"/> <documentation value="Who|what is the subject of the document"/> </searchParam> <searchParam> <name value="relatesto"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="reference"/> <documentation value="Target of the relationship"/> </searchParam> <searchParam> <name value="relation"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="token"/> <documentation value="replaces | transforms | signs | appends"/> </searchParam> <searchParam> <name value="class"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="token"/> <documentation value="Categorization of Document"/> </searchParam> <searchParam> <name value="format"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="token"/> <documentation value="Format/content rules for the document"/> </searchParam> <searchParam> <name value="period"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="date"/> <documentation value="Time of service that is being documented"/> </searchParam> <searchParam> <name value="type"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="token"/> <documentation value="What kind of document this is (LOINC if possible)"/> </searchParam> <searchParam> <name value="authenticator"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="reference"/> <documentation value="Who/What authenticated the document"/> </searchParam> <searchParam> <name value="size"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="number"/> <documentation value="Size of the document in bytes"/> </searchParam> <searchParam> <name value="relationship"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="composite"/> <documentation value="Combination of relation and relatesTo"/> </searchParam> <searchParam> <name value="author"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="reference"/> <documentation value="Who and/or what authored the document"/> </searchParam> <searchParam> <name value="custodian"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="reference"/> <documentation value="Org which maintains the document"/> </searchParam> <searchParam> <name value="facility"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="token"/> <documentation value="Kind of facility where patient was seen"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="created"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="date"/> <documentation value="Document creation time"/> </searchParam> <searchParam> <name value="event"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="token"/> <documentation value="Main Clinical Acts Documented"/> </searchParam> <searchParam> <name value="confidentiality"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="token"/> <documentation value="Sensitivity of source document"/> </searchParam> <searchParam> <name value="description"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="string"/> <documentation value="Human-readable description (title)"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="language"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="token"/> <documentation value="The marked primary language for the document"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="token"/> <documentation value="Master Version Specific Identifier"/> </searchParam> </resource> <resource> <type value="Encounter"/> <profile> <reference value="http://hl7.org/fhir/Encounter"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Encounter"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="location"/> <definition value="http://hl7.org/fhir/profiles/Encounter"/> <type value="reference"/> <documentation value="Location the encounter takes place"/> </searchParam> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/Encounter"/> <type value="token"/> <documentation value="planned | in progress | onleave | finished | cancelled"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/Encounter"/> <type value="reference"/> <documentation value="The patient present at the encounter"/> </searchParam> <searchParam> <name value="indication"/> <definition value="http://hl7.org/fhir/profiles/Encounter"/> <type value="reference"/> <documentation value="Reason the encounter takes place (resource)"/> </searchParam> <searchParam> <name value="length"/> <definition value="http://hl7.org/fhir/profiles/Encounter"/> <type value="number"/> <documentation value="Length of encounter in days"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Encounter"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/Encounter"/> <type value="date"/> <documentation value="A date within the period the Encounter lasted"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/Encounter"/> <type value="token"/> <documentation value="Identifier(s) by which this encounter is known"/> </searchParam> <searchParam> <name value="location-period"/> <definition value="http://hl7.org/fhir/profiles/Encounter"/> <type value="date"/> <documentation value="Time period during which the patient was present at the location"/> </searchParam> </resource> <resource> <type value="FamilyHistory"/> <profile> <reference value="http://hl7.org/fhir/FamilyHistory"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/FamilyHistory"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/FamilyHistory"/> <type value="reference"/> <documentation value="The identity of a subject to list family history items for"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/FamilyHistory"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> </resource> <resource> <type value="Group"/> <profile> <reference value="http://hl7.org/fhir/Group"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="member"/> <definition value="http://hl7.org/fhir/profiles/Group"/> <type value="reference"/> <documentation value="Who is in group"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Group"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="characteristic-value"/> <definition value="http://hl7.org/fhir/profiles/Group"/> <type value="composite"/> <documentation value="A composite of both characteristic and value"/> </searchParam> <searchParam> <name value="value"/> <definition value="http://hl7.org/fhir/profiles/Group"/> <type value="token"/> <documentation value="Value held by characteristic"/> </searchParam> <searchParam> <name value="actual"/> <definition value="http://hl7.org/fhir/profiles/Group"/> <type value="token"/> <documentation value="Descriptive or actual"/> </searchParam> <searchParam> <name value="exclude"/> <definition value="http://hl7.org/fhir/profiles/Group"/> <type value="token"/> <documentation value="Group includes or excludes"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Group"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="code"/> <definition value="http://hl7.org/fhir/profiles/Group"/> <type value="token"/> <documentation value="The kind of resources contained"/> </searchParam> <searchParam> <name value="characteristic"/> <definition value="http://hl7.org/fhir/profiles/Group"/> <type value="token"/> <documentation value="Kind of characteristic"/> </searchParam> <searchParam> <name value="type"/> <definition value="http://hl7.org/fhir/profiles/Group"/> <type value="token"/> <documentation value="The type of resources the group contains"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/Group"/> <type value="token"/> <documentation value="Unique id"/> </searchParam> </resource> <resource> <type value="ImagingStudy"/> <profile> <reference value="http://hl7.org/fhir/ImagingStudy"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="uid"/> <definition value="http://hl7.org/fhir/profiles/ImagingStudy"/> <type value="token"/> <documentation value="Formal identifier for this instance (0008,0018)"/> </searchParam> <searchParam> <name value="series"/> <definition value="http://hl7.org/fhir/profiles/ImagingStudy"/> <type value="token"/> <documentation value="The series id for the image"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/ImagingStudy"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="bodysite"/> <definition value="http://hl7.org/fhir/profiles/ImagingStudy"/> <type value="token"/> <documentation value="Body part examined (Map from 0018,0015)"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/ImagingStudy"/> <type value="reference"/> <documentation value="Who the study is about"/> </searchParam> <searchParam> <name value="accession"/> <definition value="http://hl7.org/fhir/profiles/ImagingStudy"/> <type value="token"/> <documentation value="The accession id for the image"/> </searchParam> <searchParam> <name value="study"/> <definition value="http://hl7.org/fhir/profiles/ImagingStudy"/> <type value="token"/> <documentation value="The study id for the image"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/ImagingStudy"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="modality"/> <definition value="http://hl7.org/fhir/profiles/ImagingStudy"/> <type value="token"/> <documentation value="The modality of the image"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/ImagingStudy"/> <type value="date"/> <documentation value="The date the study was done was taken"/> </searchParam> <searchParam> <name value="dicom-class"/> <definition value="http://hl7.org/fhir/profiles/ImagingStudy"/> <type value="token"/> <documentation value="DICOM class type (0008,0016)"/> </searchParam> <searchParam> <name value="size"/> <definition value="http://hl7.org/fhir/profiles/ImagingStudy"/> <type value="number"/> <documentation value="The size of the image in MB - may include > or < in the value"/> </searchParam> </resource> <resource> <type value="Immunization"/> <profile> <reference value="http://hl7.org/fhir/Immunization"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="reaction"/> <definition value="http://hl7.org/fhir/profiles/Immunization"/> <type value="reference"/> <documentation value="Additional information on reaction"/> </searchParam> <searchParam> <name value="requester"/> <definition value="http://hl7.org/fhir/profiles/Immunization"/> <type value="reference"/> <documentation value="The practitioner who ordered the vaccination"/> </searchParam> <searchParam> <name value="dose-sequence"/> <definition value="http://hl7.org/fhir/profiles/Immunization"/> <type value="number"/> <documentation value="What dose number within series?"/> </searchParam> <searchParam> <name value="vaccine-type"/> <definition value="http://hl7.org/fhir/profiles/Immunization"/> <type value="token"/> <documentation value="Vaccine Product Type Administered"/> </searchParam> <searchParam> <name value="location"/> <definition value="http://hl7.org/fhir/profiles/Immunization"/> <type value="reference"/> <documentation value="The service delivery location or facility in which the vaccine was / was to be administered"/> </searchParam> <searchParam> <name value="reason"/> <definition value="http://hl7.org/fhir/profiles/Immunization"/> <type value="token"/> <documentation value="Why immunization occurred"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/Immunization"/> <type value="reference"/> <documentation value="The subject of the vaccination event / refusal"/> </searchParam> <searchParam> <name value="reaction-date"/> <definition value="http://hl7.org/fhir/profiles/Immunization"/> <type value="date"/> <documentation value="When did reaction start?"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/Immunization"/> <type value="date"/> <documentation value="Vaccination Administration / Refusal Date"/> </searchParam> <searchParam> <name value="lot-number"/> <definition value="http://hl7.org/fhir/profiles/Immunization"/> <type value="string"/> <documentation value="Vaccine Lot Number"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Immunization"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="manufacturer"/> <definition value="http://hl7.org/fhir/profiles/Immunization"/> <type value="reference"/> <documentation value="Vaccine Manufacturer"/> </searchParam> <searchParam> <name value="performer"/> <definition value="http://hl7.org/fhir/profiles/Immunization"/> <type value="reference"/> <documentation value="The practitioner who administered the vaccination"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Immunization"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="refused"/> <definition value="http://hl7.org/fhir/profiles/Immunization"/> <type value="token"/> <documentation value="Was immunization refused?"/> </searchParam> <searchParam> <name value="refusal-reason"/> <definition value="http://hl7.org/fhir/profiles/Immunization"/> <type value="token"/> <documentation value="Explanation of refusal / exemption"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/Immunization"/> <type value="token"/> <documentation value="Business identifier"/> </searchParam> </resource> <resource> <type value="ImmunizationRecommendation"/> <profile> <reference value="http://hl7.org/fhir/ImmunizationRecommendation"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="information"/> <definition value="http://hl7.org/fhir/profiles/ImmunizationRecommendation"/> <type value="reference"/> <documentation value="Patient observations supporting recommendation"/> </searchParam> <searchParam> <name value="dose-sequence"/> <definition value="http://hl7.org/fhir/profiles/ImmunizationRecommendation"/> <type value="token"/> <documentation value="Number of dose within sequence"/> </searchParam> <searchParam> <name value="support"/> <definition value="http://hl7.org/fhir/profiles/ImmunizationRecommendation"/> <type value="reference"/> <documentation value="Past immunizations supporting recommendation"/> </searchParam> <searchParam> <name value="vaccine-type"/> <definition value="http://hl7.org/fhir/profiles/ImmunizationRecommendation"/> <type value="token"/> <documentation value="Vaccine recommendation applies to"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/ImmunizationRecommendation"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/ImmunizationRecommendation"/> <type value="token"/> <documentation value="Vaccine administration status"/> </searchParam> <searchParam> <name value="dose-number"/> <definition value="http://hl7.org/fhir/profiles/ImmunizationRecommendation"/> <type value="number"/> <documentation value="Recommended dose number"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/ImmunizationRecommendation"/> <type value="reference"/> <documentation value="Who this profile is for"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/ImmunizationRecommendation"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/ImmunizationRecommendation"/> <type value="date"/> <documentation value="Date recommendation created"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/ImmunizationRecommendation"/> <type value="token"/> <documentation value="Business identifier"/> </searchParam> </resource> <resource> <type value="List"/> <profile> <reference value="http://hl7.org/fhir/List"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="source"/> <definition value="http://hl7.org/fhir/profiles/List"/> <type value="reference"/> <documentation value="Who and/or what defined the list contents"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/List"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/List"/> <type value="reference"/> <documentation value="If all resources have the same subject"/> </searchParam> <searchParam> <name value="item"/> <definition value="http://hl7.org/fhir/profiles/List"/> <type value="reference"/> <documentation value="Actual entry"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/List"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="code"/> <definition value="http://hl7.org/fhir/profiles/List"/> <type value="token"/> <documentation value="What the purpose of this list is"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/List"/> <type value="date"/> <documentation value="When the list was prepared"/> </searchParam> <searchParam> <name value="empty-reason"/> <definition value="http://hl7.org/fhir/profiles/List"/> <type value="token"/> <documentation value="Why list is empty"/> </searchParam> </resource> <resource> <type value="Location"/> <profile> <reference value="http://hl7.org/fhir/Location"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="near"/> <definition value="http://hl7.org/fhir/profiles/Location"/> <type value="token"/> <documentation value="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)"/> </searchParam> <searchParam> <name value="partof"/> <definition value="http://hl7.org/fhir/profiles/Location"/> <type value="reference"/> <documentation value="The location of which this location is a part"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Location"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/Location"/> <type value="token"/> <documentation value="Searches for locations with a specific kind of status"/> </searchParam> <searchParam> <name value="address"/> <definition value="http://hl7.org/fhir/profiles/Location"/> <type value="string"/> <documentation value="A (part of the) address of the location"/> </searchParam> <searchParam> <name value="name"/> <definition value="http://hl7.org/fhir/profiles/Location"/> <type value="string"/> <documentation value="A (portion of the) name of the location"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Location"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="near-distance"/> <definition value="http://hl7.org/fhir/profiles/Location"/> <type value="token"/> <documentation value="A distance quantity to limit the near search to locations within a specific distance"/> </searchParam> <searchParam> <name value="type"/> <definition value="http://hl7.org/fhir/profiles/Location"/> <type value="token"/> <documentation value="A code for the type of location"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/Location"/> <type value="token"/> <documentation value="Unique code or number identifying the location to its users"/> </searchParam> </resource> <resource> <type value="Media"/> <profile> <reference value="http://hl7.org/fhir/Media"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Media"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/Media"/> <type value="reference"/> <documentation value="Who/What this Media is a record of"/> </searchParam> <searchParam> <name value="subtype"/> <definition value="http://hl7.org/fhir/profiles/Media"/> <type value="token"/> <documentation value="The type of acquisition equipment/process"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Media"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="view"/> <definition value="http://hl7.org/fhir/profiles/Media"/> <type value="token"/> <documentation value="Imaging view e.g Lateral or Antero-posterior"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/Media"/> <type value="date"/> <documentation value="When the media was taken/recorded (end)"/> </searchParam> <searchParam> <name value="type"/> <definition value="http://hl7.org/fhir/profiles/Media"/> <type value="token"/> <documentation value="photo | video | audio"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/Media"/> <type value="token"/> <documentation value="Identifier(s) for the image"/> </searchParam> <searchParam> <name value="operator"/> <definition value="http://hl7.org/fhir/profiles/Media"/> <type value="reference"/> <documentation value="The person who generated the image"/> </searchParam> </resource> <resource> <type value="Medication"/> <profile> <reference value="http://hl7.org/fhir/Medication"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="content"/> <definition value="http://hl7.org/fhir/profiles/Medication"/> <type value="reference"/> <documentation value="A product in the package"/> </searchParam> <searchParam> <name value="form"/> <definition value="http://hl7.org/fhir/profiles/Medication"/> <type value="token"/> <documentation value="powder | tablets | carton +"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Medication"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="container"/> <definition value="http://hl7.org/fhir/profiles/Medication"/> <type value="token"/> <documentation value="E.g. box, vial, blister-pack"/> </searchParam> <searchParam> <name value="manufacturer"/> <definition value="http://hl7.org/fhir/profiles/Medication"/> <type value="reference"/> <documentation value="Manufacturer of the item"/> </searchParam> <searchParam> <name value="name"/> <definition value="http://hl7.org/fhir/profiles/Medication"/> <type value="string"/> <documentation value="Common / Commercial name"/> </searchParam> <searchParam> <name value="ingredient"/> <definition value="http://hl7.org/fhir/profiles/Medication"/> <type value="reference"/> <documentation value="The product contained"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Medication"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="code"/> <definition value="http://hl7.org/fhir/profiles/Medication"/> <type value="token"/> <documentation value="Codes that identify this medication"/> </searchParam> </resource> <resource> <type value="MedicationAdministration"/> <profile> <reference value="http://hl7.org/fhir/MedicationAdministration"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="medication"/> <definition value="http://hl7.org/fhir/profiles/MedicationAdministration"/> <type value="reference"/> <documentation value="Return administrations of this medication"/> </searchParam> <searchParam> <name value="patient"/> <definition value="http://hl7.org/fhir/profiles/MedicationAdministration"/> <type value="reference"/> <documentation value="The identity of a patient to list administrations for"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/MedicationAdministration"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/MedicationAdministration"/> <type value="token"/> <documentation value="MedicationAdministration event status (for example one of active/paused/completed/nullified)"/> </searchParam> <searchParam> <name value="prescription"/> <definition value="http://hl7.org/fhir/profiles/MedicationAdministration"/> <type value="reference"/> <documentation value="The identity of a prescription to list administrations from"/> </searchParam> <searchParam> <name value="device"/> <definition value="http://hl7.org/fhir/profiles/MedicationAdministration"/> <type value="reference"/> <documentation value="Return administrations with this administration device identity"/> </searchParam> <searchParam> <name value="notgiven"/> <definition value="http://hl7.org/fhir/profiles/MedicationAdministration"/> <type value="token"/> <documentation value="Administrations that were not made"/> </searchParam> <searchParam> <name value="whengiven"/> <definition value="http://hl7.org/fhir/profiles/MedicationAdministration"/> <type value="date"/> <documentation value="Date of administration"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/MedicationAdministration"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="encounter"/> <definition value="http://hl7.org/fhir/profiles/MedicationAdministration"/> <type value="reference"/> <documentation value="Return administrations that share this encounter"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/MedicationAdministration"/> <type value="token"/> <documentation value="Return administrations with this external identity"/> </searchParam> </resource> <resource> <type value="MedicationDispense"/> <profile> <reference value="http://hl7.org/fhir/MedicationDispense"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="medication"/> <definition value="http://hl7.org/fhir/profiles/MedicationDispense"/> <type value="reference"/> <documentation value="Returns dispenses of this medicine"/> </searchParam> <searchParam> <name value="prescription"/> <definition value="http://hl7.org/fhir/profiles/MedicationDispense"/> <type value="reference"/> <documentation value="The identity of a prescription to list dispenses from"/> </searchParam> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/MedicationDispense"/> <type value="token"/> <documentation value="Status of the dispense"/> </searchParam> <searchParam> <name value="type"/> <definition value="http://hl7.org/fhir/profiles/MedicationDispense"/> <type value="token"/> <documentation value="Return all dispenses of a specific type"/> </searchParam> <searchParam> <name value="destination"/> <definition value="http://hl7.org/fhir/profiles/MedicationDispense"/> <type value="reference"/> <documentation value="Return dispenses that should be sent to a secific destination"/> </searchParam> <searchParam> <name value="patient"/> <definition value="http://hl7.org/fhir/profiles/MedicationDispense"/> <type value="reference"/> <documentation value="The identity of a patient to list dispenses for"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/MedicationDispense"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="responsibleparty"/> <definition value="http://hl7.org/fhir/profiles/MedicationDispense"/> <type value="reference"/> <documentation value="Return all dispenses with the specified responsible party"/> </searchParam> <searchParam> <name value="dispenser"/> <definition value="http://hl7.org/fhir/profiles/MedicationDispense"/> <type value="reference"/> <documentation value="Return all dispenses performed by a specific indiividual"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/MedicationDispense"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/MedicationDispense"/> <type value="token"/> <documentation value="Return dispenses with this external identity"/> </searchParam> <searchParam> <name value="whenhandedover"/> <definition value="http://hl7.org/fhir/profiles/MedicationDispense"/> <type value="date"/> <documentation value="Date when medication handed over to patient (outpatient setting), or supplied to ward or clinic (inpatient setting)"/> </searchParam> <searchParam> <name value="whenprepared"/> <definition value="http://hl7.org/fhir/profiles/MedicationDispense"/> <type value="date"/> <documentation value="Date when medication prepared"/> </searchParam> </resource> <resource> <type value="MedicationPrescription"/> <profile> <reference value="http://hl7.org/fhir/MedicationPrescription"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="medication"/> <definition value="http://hl7.org/fhir/profiles/MedicationPrescription"/> <type value="reference"/> <documentation value="Code for medicine or text in medicine name"/> </searchParam> <searchParam> <name value="datewritten"/> <definition value="http://hl7.org/fhir/profiles/MedicationPrescription"/> <type value="date"/> <documentation value="Return prescriptions written on this date"/> </searchParam> <searchParam> <name value="patient"/> <definition value="http://hl7.org/fhir/profiles/MedicationPrescription"/> <type value="reference"/> <documentation value="The identity of a patient to list dispenses for"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/MedicationPrescription"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/MedicationPrescription"/> <type value="token"/> <documentation value="Status of the prescription"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/MedicationPrescription"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="encounter"/> <definition value="http://hl7.org/fhir/profiles/MedicationPrescription"/> <type value="reference"/> <documentation value="Return prescriptions with this encounter identity"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/MedicationPrescription"/> <type value="token"/> <documentation value="Return prescriptions with this external identity"/> </searchParam> </resource> <resource> <type value="MedicationStatement"/> <profile> <reference value="http://hl7.org/fhir/MedicationStatement"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="medication"/> <definition value="http://hl7.org/fhir/profiles/MedicationStatement"/> <type value="reference"/> <documentation value="Code for medicine or text in medicine name"/> </searchParam> <searchParam> <name value="patient"/> <definition value="http://hl7.org/fhir/profiles/MedicationStatement"/> <type value="reference"/> <documentation value="The identity of a patient to list administrations for"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/MedicationStatement"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="device"/> <definition value="http://hl7.org/fhir/profiles/MedicationStatement"/> <type value="reference"/> <documentation value="Return administrations with this administration device identity"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/MedicationStatement"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="when-given"/> <definition value="http://hl7.org/fhir/profiles/MedicationStatement"/> <type value="date"/> <documentation value="Date of administration"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/MedicationStatement"/> <type value="token"/> <documentation value="Return administrations with this external identity"/> </searchParam> </resource> <resource> <type value="MessageHeader"/> <profile> <reference value="http://hl7.org/fhir/MessageHeader"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/MessageHeader"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/MessageHeader"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> </resource> <resource> <type value="Observation"/> <profile> <reference value="http://hl7.org/fhir/Observation"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="value-string"/> <definition value="http://hl7.org/fhir/profiles/Observation"/> <type value="string"/> <documentation value="The value of the observation, if the value is a string, and also searches in CodeableConcept.text"/> </searchParam> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/Observation"/> <type value="token"/> <documentation value="The status of the observation"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/Observation"/> <type value="reference"/> <documentation value="The subject that the observation is about"/> </searchParam> <searchParam> <name value="value-concept"/> <definition value="http://hl7.org/fhir/profiles/Observation"/> <type value="token"/> <documentation value="The value of the observation, if the value is a CodeableConcept"/> </searchParam> <searchParam> <name value="reliability"/> <definition value="http://hl7.org/fhir/profiles/Observation"/> <type value="token"/> <documentation value="The reliability of the observation"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/Observation"/> <type value="date"/> <documentation value="Obtained date/time. If the obtained element is a period, a date that falls in the period"/> </searchParam> <searchParam> <name value="name-value-[x]"/> <definition value="http://hl7.org/fhir/profiles/Observation"/> <type value="composite"/> <documentation value="Both name and one of the value parameters"/> </searchParam> <searchParam> <name value="related-target"/> <definition value="http://hl7.org/fhir/profiles/Observation"/> <type value="reference"/> <documentation value="Observation that is related to this one"/> </searchParam> <searchParam> <name value="related"/> <definition value="http://hl7.org/fhir/profiles/Observation"/> <type value="composite"/> <documentation value="Related Observations - search on related-type and related-target together"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Observation"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="specimen"/> <definition value="http://hl7.org/fhir/profiles/Observation"/> <type value="reference"/> <documentation value="Specimen used for this observation"/> </searchParam> <searchParam> <name value="name"/> <definition value="http://hl7.org/fhir/profiles/Observation"/> <type value="token"/> <documentation value="The name of the observation type"/> </searchParam> <searchParam> <name value="related-type"/> <definition value="http://hl7.org/fhir/profiles/Observation"/> <type value="token"/> <documentation value="has-component | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by"/> </searchParam> <searchParam> <name value="performer"/> <definition value="http://hl7.org/fhir/profiles/Observation"/> <type value="reference"/> <documentation value="Who and/or what performed the observation"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Observation"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="value-quantity"/> <definition value="http://hl7.org/fhir/profiles/Observation"/> <type value="quantity"/> <documentation value="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)"/> </searchParam> <searchParam> <name value="value-date"/> <definition value="http://hl7.org/fhir/profiles/Observation"/> <type value="date"/> <documentation value="The value of the observation, if the value is a Period"/> </searchParam> </resource> <resource> <type value="OperationOutcome"/> <profile> <reference value="http://hl7.org/fhir/OperationOutcome"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/OperationOutcome"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/OperationOutcome"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> </resource> <resource> <type value="Order"/> <profile> <reference value="http://hl7.org/fhir/Order"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="authority"/> <definition value="http://hl7.org/fhir/profiles/Order"/> <type value="reference"/> <documentation value="If required by policy"/> </searchParam> <searchParam> <name value="detail"/> <definition value="http://hl7.org/fhir/profiles/Order"/> <type value="reference"/> <documentation value="What action is being ordered"/> </searchParam> <searchParam> <name value="source"/> <definition value="http://hl7.org/fhir/profiles/Order"/> <type value="reference"/> <documentation value="Who initiated the order"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Order"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/Order"/> <type value="reference"/> <documentation value="Patient this order is about"/> </searchParam> <searchParam> <name value="when"/> <definition value="http://hl7.org/fhir/profiles/Order"/> <type value="date"/> <documentation value="A formal schedule"/> </searchParam> <searchParam> <name value="target"/> <definition value="http://hl7.org/fhir/profiles/Order"/> <type value="reference"/> <documentation value="Who is intended to fulfill the order"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Order"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="when_code"/> <definition value="http://hl7.org/fhir/profiles/Order"/> <type value="token"/> <documentation value="Code specifies when request should be done. The code may simply be a priority code"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/Order"/> <type value="date"/> <documentation value="When the order was made"/> </searchParam> </resource> <resource> <type value="OrderResponse"/> <profile> <reference value="http://hl7.org/fhir/OrderResponse"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/OrderResponse"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="fulfillment"/> <definition value="http://hl7.org/fhir/profiles/OrderResponse"/> <type value="reference"/> <documentation value="Details of the outcome of performing the order"/> </searchParam> <searchParam> <name value="request"/> <definition value="http://hl7.org/fhir/profiles/OrderResponse"/> <type value="reference"/> <documentation value="The order that this is a response to"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/OrderResponse"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="code"/> <definition value="http://hl7.org/fhir/profiles/OrderResponse"/> <type value="token"/> <documentation value="pending | review | rejected | error | accepted | cancelled | replaced | aborted | complete"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/OrderResponse"/> <type value="date"/> <documentation value="When the response was made"/> </searchParam> <searchParam> <name value="who"/> <definition value="http://hl7.org/fhir/profiles/OrderResponse"/> <type value="reference"/> <documentation value="Who made the response"/> </searchParam> </resource> <resource> <type value="Organization"/> <profile> <reference value="http://hl7.org/fhir/Organization"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="phonetic"/> <definition value="http://hl7.org/fhir/profiles/Organization"/> <type value="string"/> <documentation value="A portion of the organization's name using some kind of phonetic matching algorithm"/> </searchParam> <searchParam> <name value="partof"/> <definition value="http://hl7.org/fhir/profiles/Organization"/> <type value="reference"/> <documentation value="Search all organizations that are part of the given organization"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Organization"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="name"/> <definition value="http://hl7.org/fhir/profiles/Organization"/> <type value="string"/> <documentation value="A portion of the organization's name"/> </searchParam> <searchParam> <name value="active"/> <definition value="http://hl7.org/fhir/profiles/Organization"/> <type value="token"/> <documentation value="Whether the organization's record is active"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Organization"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="type"/> <definition value="http://hl7.org/fhir/profiles/Organization"/> <type value="token"/> <documentation value="A code for the type of organization"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/Organization"/> <type value="token"/> <documentation value="Any identifier for the organization (not the accreditation issuer's identifier)"/> </searchParam> </resource> <resource> <type value="Other"/> <profile> <reference value="http://hl7.org/fhir/Other"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Other"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="created"/> <definition value="http://hl7.org/fhir/profiles/Other"/> <type value="date"/> <documentation value="When created"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/Other"/> <type value="reference"/> <documentation value="Identifies the"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Other"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="code"/> <definition value="http://hl7.org/fhir/profiles/Other"/> <type value="token"/> <documentation value="Kind of Resource"/> </searchParam> </resource> <resource> <type value="Patient"/> <profile> <reference value="http://hl7.org/fhir/Patient"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="animal-breed"/> <definition value="http://hl7.org/fhir/profiles/Patient"/> <type value="token"/> <documentation value="The breed for animal patients"/> </searchParam> <searchParam> <name value="phonetic"/> <definition value="http://hl7.org/fhir/profiles/Patient"/> <type value="string"/> <documentation value="A portion of either family or given name using some kind of phonetic matching algorithm"/> </searchParam> <searchParam> <name value="link"/> <definition value="http://hl7.org/fhir/profiles/Patient"/> <type value="reference"/> <documentation value="All patients linked to the given patient"/> </searchParam> <searchParam> <name value="provider"/> <definition value="http://hl7.org/fhir/profiles/Patient"/> <type value="reference"/> <documentation value="The organization at which this person is a patient"/> </searchParam> <searchParam> <name value="animal-species"/> <definition value="http://hl7.org/fhir/profiles/Patient"/> <type value="token"/> <documentation value="The species for animal patients"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Patient"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="given"/> <definition value="http://hl7.org/fhir/profiles/Patient"/> <type value="string"/> <documentation value="A portion of the given name of the patient"/> </searchParam> <searchParam> <name value="address"/> <definition value="http://hl7.org/fhir/profiles/Patient"/> <type value="string"/> <documentation value="An address in any kind of address/part of the patient"/> </searchParam> <searchParam> <name value="family"/> <definition value="http://hl7.org/fhir/profiles/Patient"/> <type value="string"/> <documentation value="A portion of the family name of the patient"/> </searchParam> <searchParam> <name value="name"/> <definition value="http://hl7.org/fhir/profiles/Patient"/> <type value="string"/> <documentation value="A portion of either family or given name of the patient"/> </searchParam> <searchParam> <name value="telecom"/> <definition value="http://hl7.org/fhir/profiles/Patient"/> <type value="string"/> <documentation value="The value in any kind of telecom details of the patient"/> </searchParam> <searchParam> <name value="birthdate"/> <definition value="http://hl7.org/fhir/profiles/Patient"/> <type value="date"/> <documentation value="The patient's date of birth"/> </searchParam> <searchParam> <name value="active"/> <definition value="http://hl7.org/fhir/profiles/Patient"/> <type value="token"/> <documentation value="Whether the patient record is active"/> </searchParam> <searchParam> <name value="gender"/> <definition value="http://hl7.org/fhir/profiles/Patient"/> <type value="token"/> <documentation value="Gender of the patient"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Patient"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="language"/> <definition value="http://hl7.org/fhir/profiles/Patient"/> <type value="token"/> <documentation value="Language code (irrespective of use value)"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/Patient"/> <type value="token"/> <documentation value="A patient identifier"/> </searchParam> </resource> <resource> <type value="Practitioner"/> <profile> <reference value="http://hl7.org/fhir/Practitioner"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="organization"/> <definition value="http://hl7.org/fhir/profiles/Practitioner"/> <type value="reference"/> <documentation value="The identity of the organization the practitioner represents / acts on behalf of"/> </searchParam> <searchParam> <name value="phonetic"/> <definition value="http://hl7.org/fhir/profiles/Practitioner"/> <type value="string"/> <documentation value="A portion of either family or given name using some kind of phonetic matching algorithm"/> </searchParam> <searchParam> <name value="given"/> <definition value="http://hl7.org/fhir/profiles/Practitioner"/> <type value="string"/> <documentation value="A portion of the given name"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Practitioner"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="address"/> <definition value="http://hl7.org/fhir/profiles/Practitioner"/> <type value="string"/> <documentation value="An address in any kind of address/part"/> </searchParam> <searchParam> <name value="family"/> <definition value="http://hl7.org/fhir/profiles/Practitioner"/> <type value="string"/> <documentation value="A portion of the family name"/> </searchParam> <searchParam> <name value="name"/> <definition value="http://hl7.org/fhir/profiles/Practitioner"/> <type value="string"/> <documentation value="A portion of either family or given name"/> </searchParam> <searchParam> <name value="telecom"/> <definition value="http://hl7.org/fhir/profiles/Practitioner"/> <type value="string"/> <documentation value="The value in any kind of contact"/> </searchParam> <searchParam> <name value="gender"/> <definition value="http://hl7.org/fhir/profiles/Practitioner"/> <type value="token"/> <documentation value="Gender of the practitioner"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Practitioner"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/Practitioner"/> <type value="token"/> <documentation value="A practitioner's Identifier"/> </searchParam> </resource> <resource> <type value="Procedure"/> <profile> <reference value="http://hl7.org/fhir/Procedure"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Procedure"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/Procedure"/> <type value="reference"/> <documentation value="The identity of a patient to list procedures for"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Procedure"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/Procedure"/> <type value="date"/> <documentation value="The date the procedure was performed on"/> </searchParam> <searchParam> <name value="type"/> <definition value="http://hl7.org/fhir/profiles/Procedure"/> <type value="token"/> <documentation value="Type of procedure"/> </searchParam> </resource> <resource> <type value="Profile"/> <profile> <reference value="http://hl7.org/fhir/Profile"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/Profile"/> <type value="token"/> <documentation value="The current status of the profile"/> </searchParam> <searchParam> <name value="code"/> <definition value="http://hl7.org/fhir/profiles/Profile"/> <type value="token"/> <documentation value="A code for the profile in the format uri::code (server may choose to do subsumption)"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/Profile"/> <type value="date"/> <documentation value="The profile publication date"/> </searchParam> <searchParam> <name value="type"/> <definition value="http://hl7.org/fhir/profiles/Profile"/> <type value="token"/> <documentation value="Type of resource that is constrained in the profile"/> </searchParam> <searchParam> <name value="version"/> <definition value="http://hl7.org/fhir/profiles/Profile"/> <type value="token"/> <documentation value="The version identifier of the profile"/> </searchParam> <searchParam> <name value="publisher"/> <definition value="http://hl7.org/fhir/profiles/Profile"/> <type value="string"/> <documentation value="Name of the publisher of the profile"/> </searchParam> <searchParam> <name value="extension"/> <definition value="http://hl7.org/fhir/profiles/Profile"/> <type value="token"/> <documentation value="An extension code (use or definition)"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Profile"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="valueset"/> <definition value="http://hl7.org/fhir/profiles/Profile"/> <type value="reference"/> <documentation value="A vocabulary binding code"/> </searchParam> <searchParam> <name value="description"/> <definition value="http://hl7.org/fhir/profiles/Profile"/> <type value="string"/> <documentation value="Text search in the description of the profile"/> </searchParam> <searchParam> <name value="name"/> <definition value="http://hl7.org/fhir/profiles/Profile"/> <type value="string"/> <documentation value="Name of the profile"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Profile"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/Profile"/> <type value="token"/> <documentation value="The identifier of the profile"/> </searchParam> </resource> <resource> <type value="Provenance"/> <profile> <reference value="http://hl7.org/fhir/Provenance"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Provenance"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="location"/> <definition value="http://hl7.org/fhir/profiles/Provenance"/> <type value="reference"/> <documentation value="Where the activity occurred, if relevant"/> </searchParam> <searchParam> <name value="start"/> <definition value="http://hl7.org/fhir/profiles/Provenance"/> <type value="date"/> <documentation value="Starting time with inclusive boundary"/> </searchParam> <searchParam> <name value="partytype"/> <definition value="http://hl7.org/fhir/profiles/Provenance"/> <type value="token"/> <documentation value="e.g. Resource | Person | Application | Record | Document +"/> </searchParam> <searchParam> <name value="target"/> <definition value="http://hl7.org/fhir/profiles/Provenance"/> <type value="reference"/> <documentation value="Target resource(s) (usually version specific)"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Provenance"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="party"/> <definition value="http://hl7.org/fhir/profiles/Provenance"/> <type value="token"/> <documentation value="Identity of agent (urn or url)"/> </searchParam> <searchParam> <name value="end"/> <definition value="http://hl7.org/fhir/profiles/Provenance"/> <type value="date"/> <documentation value="End time with inclusive boundary, if not ongoing"/> </searchParam> </resource> <resource> <type value="Query"/> <profile> <reference value="http://hl7.org/fhir/Query"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="response"/> <definition value="http://hl7.org/fhir/profiles/Query"/> <type value="token"/> <documentation value="Links response to source query"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Query"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Query"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/Query"/> <type value="token"/> <documentation value="Links query and its response(s)"/> </searchParam> </resource> <resource> <type value="Questionnaire"/> <profile> <reference value="http://hl7.org/fhir/Questionnaire"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="author"/> <definition value="http://hl7.org/fhir/profiles/Questionnaire"/> <type value="reference"/> <documentation value="The author of the questionnaire"/> </searchParam> <searchParam> <name value="authored"/> <definition value="http://hl7.org/fhir/profiles/Questionnaire"/> <type value="date"/> <documentation value="When the questionnaire was authored"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Questionnaire"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/Questionnaire"/> <type value="token"/> <documentation value="The status of the questionnaire"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/Questionnaire"/> <type value="reference"/> <documentation value="The subject of the questionnaire"/> </searchParam> <searchParam> <name value="name"/> <definition value="http://hl7.org/fhir/profiles/Questionnaire"/> <type value="token"/> <documentation value="Name of the questionnaire"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Questionnaire"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="encounter"/> <definition value="http://hl7.org/fhir/profiles/Questionnaire"/> <type value="reference"/> <documentation value="Encounter during which questionnaire was authored"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/Questionnaire"/> <type value="token"/> <documentation value="An identifier for the questionnaire"/> </searchParam> </resource> <resource> <type value="RelatedPerson"/> <profile> <reference value="http://hl7.org/fhir/RelatedPerson"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="patient"/> <definition value="http://hl7.org/fhir/profiles/RelatedPerson"/> <type value="reference"/> <documentation value="The patient this person is related to"/> </searchParam> <searchParam> <name value="phonetic"/> <definition value="http://hl7.org/fhir/profiles/RelatedPerson"/> <type value="string"/> <documentation value="A portion of name using some kind of phonetic matching algorithm"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/RelatedPerson"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="address"/> <definition value="http://hl7.org/fhir/profiles/RelatedPerson"/> <type value="string"/> <documentation value="An address in any kind of address/part"/> </searchParam> <searchParam> <name value="name"/> <definition value="http://hl7.org/fhir/profiles/RelatedPerson"/> <type value="string"/> <documentation value="A portion of name in any name part"/> </searchParam> <searchParam> <name value="telecom"/> <definition value="http://hl7.org/fhir/profiles/RelatedPerson"/> <type value="string"/> <documentation value="The value in any kind of contact"/> </searchParam> <searchParam> <name value="gender"/> <definition value="http://hl7.org/fhir/profiles/RelatedPerson"/> <type value="token"/> <documentation value="Gender of the person"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/RelatedPerson"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/RelatedPerson"/> <type value="token"/> <documentation value="A patient Identifier"/> </searchParam> </resource> <resource> <type value="SecurityEvent"/> <profile> <reference value="http://hl7.org/fhir/SecurityEvent"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="site"/> <definition value="http://hl7.org/fhir/profiles/SecurityEvent"/> <type value="token"/> <documentation value="Logical source location within the enterprise"/> </searchParam> <searchParam> <name value="desc"/> <definition value="http://hl7.org/fhir/profiles/SecurityEvent"/> <type value="string"/> <documentation value="Instance-specific descriptor for Object"/> </searchParam> <searchParam> <name value="type"/> <definition value="http://hl7.org/fhir/profiles/SecurityEvent"/> <type value="token"/> <documentation value="Type/identifier of event"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/SecurityEvent"/> <type value="date"/> <documentation value="Time when the event occurred on source"/> </searchParam> <searchParam> <name value="reference"/> <definition value="http://hl7.org/fhir/profiles/SecurityEvent"/> <type value="reference"/> <documentation value="Specific instance of resource (e.g. versioned)"/> </searchParam> <searchParam> <name value="identity"/> <definition value="http://hl7.org/fhir/profiles/SecurityEvent"/> <type value="token"/> <documentation value="Specific instance of object (e.g. versioned)"/> </searchParam> <searchParam> <name value="altid"/> <definition value="http://hl7.org/fhir/profiles/SecurityEvent"/> <type value="token"/> <documentation value="Alternative User id e.g. authentication"/> </searchParam> <searchParam> <name value="patientid"/> <definition value="http://hl7.org/fhir/profiles/SecurityEvent"/> <type value="token"/> <documentation value="The id of the patient (one of multiple kinds of participations)"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/SecurityEvent"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="source"/> <definition value="http://hl7.org/fhir/profiles/SecurityEvent"/> <type value="token"/> <documentation value="The id of source where event originated"/> </searchParam> <searchParam> <name value="address"/> <definition value="http://hl7.org/fhir/profiles/SecurityEvent"/> <type value="token"/> <documentation value="Identifier for the network access point of the user device"/> </searchParam> <searchParam> <name value="subtype"/> <definition value="http://hl7.org/fhir/profiles/SecurityEvent"/> <type value="token"/> <documentation value="More specific type/id for the event"/> </searchParam> <searchParam> <name value="name"/> <definition value="http://hl7.org/fhir/profiles/SecurityEvent"/> <type value="string"/> <documentation value="Human-meaningful name for the user"/> </searchParam> <searchParam> <name value="action"/> <definition value="http://hl7.org/fhir/profiles/SecurityEvent"/> <type value="token"/> <documentation value="Type of action performed during the event"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/SecurityEvent"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="object-type"/> <definition value="http://hl7.org/fhir/profiles/SecurityEvent"/> <type value="token"/> <documentation value="Object type being audited"/> </searchParam> <searchParam> <name value="user"/> <definition value="http://hl7.org/fhir/profiles/SecurityEvent"/> <type value="token"/> <documentation value="Unique identifier for the user"/> </searchParam> </resource> <resource> <type value="Specimen"/> <profile> <reference value="http://hl7.org/fhir/Specimen"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Specimen"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/Specimen"/> <type value="reference"/> <documentation value="The subject of the specimen"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Specimen"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> </resource> <resource> <type value="Substance"/> <profile> <reference value="http://hl7.org/fhir/Substance"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="substance"/> <definition value="http://hl7.org/fhir/profiles/Substance"/> <type value="reference"/> <documentation value="A component of the substance"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Substance"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="quantity"/> <definition value="http://hl7.org/fhir/profiles/Substance"/> <type value="number"/> <documentation value="Amount of substance in the package"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Substance"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="type"/> <definition value="http://hl7.org/fhir/profiles/Substance"/> <type value="token"/> <documentation value="The type of the substance"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/Substance"/> <type value="token"/> <documentation value="Identifier of the package/container"/> </searchParam> <searchParam> <name value="expiry"/> <definition value="http://hl7.org/fhir/profiles/Substance"/> <type value="date"/> <documentation value="When no longer valid to use"/> </searchParam> </resource> <resource> <type value="Supply"/> <profile> <reference value="http://hl7.org/fhir/Supply"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="patient"/> <definition value="http://hl7.org/fhir/profiles/Supply"/> <type value="reference"/> <documentation value="Patient for whom the item is supplied"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Supply"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/Supply"/> <type value="token"/> <documentation value="requested | dispensed | received | failed | cancelled"/> </searchParam> <searchParam> <name value="dispenseid"/> <definition value="http://hl7.org/fhir/profiles/Supply"/> <type value="token"/> <documentation value="External identifier"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Supply"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/Supply"/> <type value="token"/> <documentation value="Unique identifier"/> </searchParam> <searchParam> <name value="supplier"/> <definition value="http://hl7.org/fhir/profiles/Supply"/> <type value="reference"/> <documentation value="Dispenser"/> </searchParam> <searchParam> <name value="kind"/> <definition value="http://hl7.org/fhir/profiles/Supply"/> <type value="token"/> <documentation value="The kind of supply (central, non-stock, etc)"/> </searchParam> <searchParam> <name value="dispensestatus"/> <definition value="http://hl7.org/fhir/profiles/Supply"/> <type value="token"/> <documentation value="in progress | dispensed | abandoned"/> </searchParam> </resource> <resource> <type value="ValueSet"/> <profile> <reference value="http://hl7.org/fhir/ValueSet"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="system"/> <definition value="http://hl7.org/fhir/profiles/ValueSet"/> <type value="token"/> <documentation value="The system for any codes defined by this value set"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/ValueSet"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/ValueSet"/> <type value="token"/> <documentation value="The status of the value set"/> </searchParam> <searchParam> <name value="description"/> <definition value="http://hl7.org/fhir/profiles/ValueSet"/> <type value="string"/> <documentation value="Text search in the description of the value set"/> </searchParam> <searchParam> <name value="name"/> <definition value="http://hl7.org/fhir/profiles/ValueSet"/> <type value="string"/> <documentation value="The name of the value set"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/ValueSet"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="code"/> <definition value="http://hl7.org/fhir/profiles/ValueSet"/> <type value="token"/> <documentation value="A code defined in the value set"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/ValueSet"/> <type value="date"/> <documentation value="The value set publication date"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/ValueSet"/> <type value="token"/> <documentation value="The identifier of the value set"/> </searchParam> <searchParam> <name value="reference"/> <definition value="http://hl7.org/fhir/profiles/ValueSet"/> <type value="token"/> <documentation value="A code system included or excluded in the value set or an imported value set"/> </searchParam> <searchParam> <name value="publisher"/> <definition value="http://hl7.org/fhir/profiles/ValueSet"/> <type value="string"/> <documentation value="Name of the publisher of the value set"/> </searchParam> <searchParam> <name value="version"/> <definition value="http://hl7.org/fhir/profiles/ValueSet"/> <type value="token"/> <documentation value="The version identifier of the value set"/> </searchParam> </resource> <operation> <code value="transaction"/> </operation> <operation> <code value="history-system"/> </operation> <operation> <code value="search-system"/> </operation> </rest> </Conformance> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><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> </summary> </entry> <entry> <title>"conformance-base2" - to help with system development</title> <id>http://hl7.org/fhir/conformance/conformance-base2</id> <link href="http://hl7.org/implement/standards/fhir/conformance/conformance-base2" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Conformance xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><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/></tr><tr><td>System History</td><td/></tr><tr><td>System Search</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/></tr></table></div> </text> <identifier value="http://hl7.org/fhir/conformance-base2"/> <version value="0.0.82.2943"/> <name value="Base FHIR Conformance Statement (Empty)"/> <publisher value="FHIR Project Team"/> <telecom> <system value="url"/> <value value="http://hl7.org/fhir"/> </telecom> <description value="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 value="draft"/> <date value="2014-09-30T18:08:29.499+10:00"/> <fhirVersion value="0.0.82"/> <acceptUnknown value="false"/> <format value="xml"/> <format value="json"/> <rest> <mode value="server"/> <documentation value="An empty conformance statement"/> <resource> <type value="Conformance"/> <operation> <code value="read"/> </operation> </resource> </rest> </Conformance> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><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/></tr><tr><td>System History</td><td/></tr><tr><td>System Search</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/></tr></table></div> </summary> </entry> <entry> <title>"valueset" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/valueset</id> <link href="http://hl7.org/implement/standards/fhir/valueset.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="valueset-definitions.html#ValueSet" title="A value set specifies a set of codes drawn from one or more code systems."><b>ValueSet</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="valueset-definitions.html#ValueSet.identifier" 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)."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.version" 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."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.name" title="A free text natural language name describing the value set."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.publisher" title="The name of the individual or organization that published the value set."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.telecom" title="Contacts of the publisher to assist a user in finding and communicating with the publisher."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></telecom> <<a class="dict" href="valueset-definitions.html#ValueSet.description" title="A free text natural language description of the use of the value set - reason for definition, conditions of use, etc."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.copyright" title="A copyright statement relating to the value set and/or its contents."><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> <<a class="dict" href="valueset-definitions.html#ValueSet.status" title="The status of the value set (this element modifies the meaning of other elements)"><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 href="valueset-status.html" style="color: navy">draft | active | retired<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.experimental" title="This valueset was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.extensible" title="Whether this is intended to be used with an extensible binding or not."><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> <<a class="dict" href="valueset-definitions.html#ValueSet.date" title="The date that the value set status was last changed."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.define" title="When value set defines its own codes."><b>define</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-5: Value set SHALL contain either a define, a compose, or an expansion element"><b><img alt="??" src="lock.png"/> 0..1</b></span> When value set defines its own codes<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span> --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.define.system" title="URI to identify the code 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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.define.version" 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."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.define.caseSensitive" title="If code comparison is case sensitive when codes within this system are compared to each other."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.define.concept" title="Concepts in the code system."><b>concept</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Concepts in the code system --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.define.concept.code" title="Code that identifies concept."><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> <<a class="dict" href="valueset-definitions.html#ValueSet.define.concept.abstract" title="If this code is not for use as a real concept."><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> <<a class="dict" href="valueset-definitions.html#ValueSet.define.concept.display" title="Text to Display to the user."><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> <<a class="dict" href="valueset-definitions.html#ValueSet.define.concept.definition" 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."><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> <<a class="dict" href="valueset-definitions.html#ValueSet.define.concept.concept" title="Child Concepts (is-a / contains)."><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> </concept> </define> <<a class="dict" href="valueset-definitions.html#ValueSet.compose" title="When value set includes codes from elsewhere."><b>compose</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-5: Value set SHALL contain either a define, a compose, or an expansion element"><b><img alt="??" src="lock.png"/> 0..1</b></span> When value set includes codes from elsewhere --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.compose.import" title="Includes the contents of the referenced value set as a part of the contents of this value set."><b>import</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#uri">uri</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: A value set composition SHALL have an include or an import"><b><img alt="??" src="lock.png"/> 0..*</b></span> <span style="color: navy">Import the contents of another value set<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.compose.include" title="Include one or more codes from a code system."><b>include</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-1: A value set composition SHALL have an include or an import"><b><img alt="??" src="lock.png"/> 0..*</b></span> Include one or more codes from a code system<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span> --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.compose.include.system" title="The code system from which the selected codes come from."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.compose.include.version" title="The version of the code system that the codes are selected from."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.compose.include.code" 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."><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> <<a class="dict" href="valueset-definitions.html#ValueSet.compose.include.filter" 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."><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> <<a class="dict" href="valueset-definitions.html#ValueSet.compose.include.filter.property" title="A code that identifies a property defined in the code system."><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> <<a class="dict" href="valueset-definitions.html#ValueSet.compose.include.filter.op" title="The kind of operation to perform as a part of the filter criteria."><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 href="filter-operator.html" style="color: navy">= | is-a | is-not-a | regex | in | not in</a></span><span style="color: Gray"> --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.compose.include.filter.value" 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."><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> </filter> </include> <<a class="dict" href="valueset-definitions.html#ValueSet.compose.exclude" title="Exclude one or more codes from the value set."><b>exclude</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" 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"><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> </compose> <<a class="dict" href="valueset-definitions.html#ValueSet.expansion" title="When value set is an expansion."><b>expansion</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-5: Value set SHALL contain either a define, a compose, or an expansion element"><b><img alt="??" src="lock.png"/> 0..1</b></span> When value set is an expansion --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.expansion.identifier" 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."><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> <<a class="dict" href="valueset-definitions.html#ValueSet.expansion.timestamp" title="Time valueset expansion happened."><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> <<a class="dict" href="valueset-definitions.html#ValueSet.expansion.contains" title="Codes in the value set."><b>contains</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Codes in the value set --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.expansion.contains.system" title="System value for the code."><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> <<a class="dict" href="valueset-definitions.html#ValueSet.expansion.contains.code" title="Code - if blank, this is not a choosable 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" title="Inv-6: SHALL have a code or a display"><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> <<a class="dict" href="valueset-definitions.html#ValueSet.expansion.contains.display" title="User display for the concept."><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" title="Inv-6: SHALL have a code or a display"><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> <<a class="dict" href="valueset-definitions.html#ValueSet.expansion.contains.contains" title="Codes contained in this concept."><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> </contains> </expansion> </ValueSet> </pre></div> </text> <name value="valueset"/> <publisher value="FHIR Project"/> <description value="Basic Profile. A value set specifies a set of codes drawn from one or more code systems."/> <status value="draft"/> <date value="2014-09-30"/> <requirements value="Scope and Usage Value sets may be constructed in one of two ways: * A value set can define its own codes, and/or * 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 A 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 value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <structure> <type value="ValueSet"/> <publish value="true"/> <element> <path value="ValueSet"/> <definition> <short value="A set of codes drawn from one or more code systems"/> <formal value="A value set specifies a set of codes drawn from one or more code systems."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <constraint> <key value="2"/> <severity value="error"/> <human value="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 value="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))"/> </constraint> <constraint> <key value="7"/> <severity value="error"/> <human value="A defined code system (if present) SHALL have a different identifier to the value set itself"/> <xpath value="not(exists(f:define)) or (f:define/f:system/@value != f:identifier/@value)"/> </constraint> <constraint> <key value="5"/> <severity value="error"/> <human value="Value set SHALL contain either a define, a compose, or an expansion element"/> <xpath value="exists(f:define) or exists(f:compose) or exists(f:expansion)"/> </constraint> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </definition> </element> <element> <path value="ValueSet.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.identifier"/> <definition> <short value="Logical id to reference this value set"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </definition> </element> <element> <path value="ValueSet.version"/> <definition> <short value="Logical id for this version of the value set"/> <formal value="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 value="There may be multiple resource versions of the value set that have the same identifier."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </definition> </element> <element> <path value="ValueSet.name"/> <definition> <short value="Informal name for this value set"/> <formal value="A free text natural language name describing the value set."/> <comments value="Not expected to be unique."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </definition> </element> <element> <path value="ValueSet.publisher"/> <definition> <short value="Name of the publisher (Organization or individual)"/> <formal value="The name of the individual or organization that published the value set."/> <comments value="Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.telecom"/> <definition> <short value="Contact information of the publisher"/> <formal value="Contacts of the publisher to assist a user in finding and communicating with the publisher."/> <comments value="May be a web site, an email address, a telephone number (tel:), etc."/> <min value="0"/> <max value="*"/> <type> <code value="Contact"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.description"/> <definition> <short value="Human language description of the value set"/> <formal value="A free text natural language description of the use of the value set - reason for definition, conditions of use, etc."/> <comments value="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 value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </definition> </element> <element> <path value="ValueSet.copyright"/> <definition> <short value="About the value set or its content"/> <formal value="A copyright statement relating to the value set and/or its contents."/> <comments value="Frequently, the copyright differs between the value set, and codes that are included. The copyright statement should clearly differentiate between these when required."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.status"/> <definition> <short value="draft | active | retired"/> <formal value="The status of the value set."/> <comments value="Allows filtering of valuesets that are appropriate for use vs. not."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="ValueSetStatus"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/valueset-status"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </definition> </element> <element> <path value="ValueSet.experimental"/> <definition> <short value="If for testing purposes, not real usage"/> <formal value="This valueset was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage."/> <comments value="Allows filtering of valuesets that are appropriate for use vs. not."/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.extensible"/> <definition> <short value="Whether this is intended to be used with an extensible binding"/> <formal value="Whether this is intended to be used with an extensible binding or not."/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.date"/> <definition> <short value="Date for given status"/> <formal value="The date that the value set status was last changed."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </definition> </element> <element> <path value="ValueSet.define"/> <definition> <short value="When value set defines its own codes"/> <formal value="When value set defines its own codes."/> <min value="0"/> <max value="1"/> <constraint> <key value="3"/> <severity value="error"/> <human value="Within a code system definition, all the codes SHALL be unique"/> <xpath value="count(distinct-values(descendant::f:concept/f:code/@value))=count(descendant::f:concept)"/> </constraint> <constraint> <key value="8"/> <severity value="error"/> <human value="Codes must be unique"/> <xpath value="count(descendant::f:concept)=count(distinct-values(descendant::f:concept/f:code/@value))"/> </constraint> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.define.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.define.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.define.system"/> <definition> <short value="URI to identify the code system"/> <formal value="URI to identify the code system."/> <min value="1"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.define.version"/> <definition> <short value="Version of this system"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.define.caseSensitive"/> <definition> <short value="If code comparison is case sensitive"/> <formal value="If code comparison is case sensitive when codes within this system are compared to each other."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.define.concept"/> <definition> <short value="Concepts in the code system"/> <formal value="Concepts in the code system."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.define.concept.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.define.concept.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.define.concept.code"/> <definition> <short value="Code that identifies concept"/> <formal value="Code that identifies concept."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.define.concept.abstract"/> <definition> <short value="If this code is not for use as a real concept"/> <formal value="If this code is not for use as a real concept."/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.define.concept.display"/> <definition> <short value="Text to Display to the user"/> <formal value="Text to Display to the user."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.define.concept.definition"/> <definition> <short value="Formal Definition"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.define.concept.concept"/> <definition> <short value="Child Concepts (is-a / contains)"/> <formal value="Child Concepts (is-a / contains)."/> <min value="0"/> <max value="*"/> <nameReference value="ValueSet.define.concept"/> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.compose"/> <definition> <short value="When value set includes codes from elsewhere"/> <formal value="When value set includes codes from elsewhere."/> <min value="0"/> <max value="1"/> <constraint> <key value="1"/> <severity value="error"/> <human value="A value set composition SHALL have an include or an import"/> <xpath value="exists(f:include) or exists(f:import)"/> </constraint> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.compose.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.compose.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.compose.import"/> <definition> <short value="Import the contents of another value set"/> <formal value="Includes the contents of the referenced value set as a part of the contents of this value set."/> <comments value="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 value="0"/> <max value="*"/> <type> <code value="uri"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </definition> </element> <element> <path value="ValueSet.compose.include"/> <definition> <short value="Include one or more codes from a code system"/> <formal value="Include one or more codes from a code system."/> <comments value="If there are no codes or filters, the entire code system is included."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </definition> </element> <element> <path value="ValueSet.compose.include.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.compose.include.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.compose.include.system"/> <definition> <short value="The system the codes come from"/> <formal value="The code system from which the selected codes come from."/> <comments value="See [[Coding.system]] for further documentation."/> <min value="1"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </definition> </element> <element> <path value="ValueSet.compose.include.version"/> <definition> <short value="Specific version of the code system referred to"/> <formal value="The version of the code system that the codes are selected from."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </definition> </element> <element> <path value="ValueSet.compose.include.code"/> <definition> <short value="Code or concept from system"/> <formal value="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 value="Expressions are allowed if defined by the underlying code system."/> <min value="0"/> <max value="*"/> <type> <code value="code"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </definition> </element> <element> <path value="ValueSet.compose.include.filter"/> <definition> <short value="Select codes/concepts by their properties (including relationships)"/> <formal value="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 value="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 value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </definition> </element> <element> <path value="ValueSet.compose.include.filter.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.compose.include.filter.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.compose.include.filter.property"/> <definition> <short value="A property defined by the code system"/> <formal value="A code that identifies a property defined in the code system."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </definition> </element> <element> <path value="ValueSet.compose.include.filter.op"/> <definition> <short value="= | is-a | is-not-a | regex | in | not in"/> <formal value="The kind of operation to perform as a part of the filter criteria."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="FilterOperator"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/filter-operator"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </definition> </element> <element> <path value="ValueSet.compose.include.filter.value"/> <definition> <short value="Code from the system, or regex criteria"/> <formal value="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 value="Use regex matching with care - full regex matching on every SNOMED CT term is prohibitive, for example."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </definition> </element> <element> <path value="ValueSet.compose.exclude"/> <definition> <short value="Explicitly exclude codes"/> <formal value="Exclude one or more codes from the value set."/> <comments value="Usually this is used to selectively exclude codes that were included by subsumption in the inclusions."/> <min value="0"/> <max value="*"/> <nameReference value="ValueSet.compose.include"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </definition> </element> <element> <path value="ValueSet.expansion"/> <definition> <short value="When value set is an expansion"/> <formal value="When value set is an expansion."/> <min value="0"/> <max value="1"/> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.expansion.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.expansion.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.expansion.identifier"/> <definition> <short value="Uniquely identifies this expansion"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.expansion.timestamp"/> <definition> <short value="Time valueset expansion happened"/> <formal value="Time valueset expansion happened."/> <min value="1"/> <max value="1"/> <type> <code value="instant"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.expansion.contains"/> <definition> <short value="Codes in the value set"/> <formal value="Codes in the value set."/> <min value="0"/> <max value="*"/> <constraint> <key value="6"/> <severity value="error"/> <human value="SHALL have a code or a display"/> <xpath value="exists(f:code) or exists(f:display)"/> </constraint> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.expansion.contains.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.expansion.contains.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.expansion.contains.system"/> <definition> <short value="System value for the code"/> <formal value="System value for the code."/> <min value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.expansion.contains.code"/> <definition> <short value="Code - if blank, this is not a choosable code"/> <formal value="Code - if blank, this is not a choosable code."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.expansion.contains.display"/> <definition> <short value="User display for the concept"/> <formal value="User display for the concept."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ValueSet.expansion.contains.contains"/> <definition> <short value="Codes contained in this concept"/> <formal value="Codes contained in this concept."/> <min value="0"/> <max value="*"/> <nameReference value="ValueSet.expansion.contains"/> <isModifier value="false"/> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="code"/> <type value="token"/> <documentation value="A code defined in the value set"/> <xpath value="f:ValueSet/f:define/f:concept/f:code"/> </searchParam> <searchParam> <name value="date"/> <type value="date"/> <documentation value="The value set publication date"/> <xpath value="f:ValueSet/f:date"/> </searchParam> <searchParam> <name value="description"/> <type value="string"/> <documentation value="Text search in the description of the value set"/> <xpath value="f:ValueSet/f:description"/> </searchParam> <searchParam> <name value="identifier"/> <type value="token"/> <documentation value="The identifier of the value set"/> <xpath value="f:ValueSet/f:identifier"/> </searchParam> <searchParam> <name value="name"/> <type value="string"/> <documentation value="The name of the value set"/> <xpath value="f:ValueSet/f:name"/> </searchParam> <searchParam> <name value="publisher"/> <type value="string"/> <documentation value="Name of the publisher of the value set"/> <xpath value="f:ValueSet/f:publisher"/> </searchParam> <searchParam> <name value="reference"/> <type value="token"/> <documentation value="A code system included or excluded in the value set or an imported value set"/> <xpath value="f:ValueSet/f:compose/f:include/f:system"/> </searchParam> <searchParam> <name value="status"/> <type value="token"/> <documentation value="The status of the value set"/> <xpath value="f:ValueSet/f:status"/> </searchParam> <searchParam> <name value="system"/> <type value="token"/> <documentation value="The system for any codes defined by this value set"/> <xpath value="f:ValueSet/f:define/f:system"/> </searchParam> <searchParam> <name value="version"/> <type value="token"/> <documentation value="The version identifier of the value set"/> <xpath value="f:ValueSet/f:version"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="valueset-definitions.html#ValueSet" title="A value set specifies a set of codes drawn from one or more code systems."><b>ValueSet</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="valueset-definitions.html#ValueSet.identifier" 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)."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.version" 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."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.name" title="A free text natural language name describing the value set."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.publisher" title="The name of the individual or organization that published the value set."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.telecom" title="Contacts of the publisher to assist a user in finding and communicating with the publisher."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></telecom> <<a class="dict" href="valueset-definitions.html#ValueSet.description" title="A free text natural language description of the use of the value set - reason for definition, conditions of use, etc."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.copyright" title="A copyright statement relating to the value set and/or its contents."><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> <<a class="dict" href="valueset-definitions.html#ValueSet.status" title="The status of the value set (this element modifies the meaning of other elements)"><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 href="valueset-status.html" style="color: navy">draft | active | retired<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.experimental" title="This valueset was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.extensible" title="Whether this is intended to be used with an extensible binding or not."><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> <<a class="dict" href="valueset-definitions.html#ValueSet.date" title="The date that the value set status was last changed."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.define" title="When value set defines its own codes."><b>define</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-5: Value set SHALL contain either a define, a compose, or an expansion element"><b><img alt="??" src="lock.png"/> 0..1</b></span> When value set defines its own codes<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span> --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.define.system" title="URI to identify the code 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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.define.version" 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."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.define.caseSensitive" title="If code comparison is case sensitive when codes within this system are compared to each other."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.define.concept" title="Concepts in the code system."><b>concept</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Concepts in the code system --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.define.concept.code" title="Code that identifies concept."><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> <<a class="dict" href="valueset-definitions.html#ValueSet.define.concept.abstract" title="If this code is not for use as a real concept."><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> <<a class="dict" href="valueset-definitions.html#ValueSet.define.concept.display" title="Text to Display to the user."><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> <<a class="dict" href="valueset-definitions.html#ValueSet.define.concept.definition" 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."><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> <<a class="dict" href="valueset-definitions.html#ValueSet.define.concept.concept" title="Child Concepts (is-a / contains)."><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> </concept> </define> <<a class="dict" href="valueset-definitions.html#ValueSet.compose" title="When value set includes codes from elsewhere."><b>compose</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-5: Value set SHALL contain either a define, a compose, or an expansion element"><b><img alt="??" src="lock.png"/> 0..1</b></span> When value set includes codes from elsewhere --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.compose.import" title="Includes the contents of the referenced value set as a part of the contents of this value set."><b>import</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#uri">uri</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: A value set composition SHALL have an include or an import"><b><img alt="??" src="lock.png"/> 0..*</b></span> <span style="color: navy">Import the contents of another value set<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.compose.include" title="Include one or more codes from a code system."><b>include</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-1: A value set composition SHALL have an include or an import"><b><img alt="??" src="lock.png"/> 0..*</b></span> Include one or more codes from a code system<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span> --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.compose.include.system" title="The code system from which the selected codes come from."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.compose.include.version" title="The version of the code system that the codes are selected from."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.compose.include.code" 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."><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> <<a class="dict" href="valueset-definitions.html#ValueSet.compose.include.filter" 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."><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> <<a class="dict" href="valueset-definitions.html#ValueSet.compose.include.filter.property" title="A code that identifies a property defined in the code system."><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> <<a class="dict" href="valueset-definitions.html#ValueSet.compose.include.filter.op" title="The kind of operation to perform as a part of the filter criteria."><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 href="filter-operator.html" style="color: navy">= | is-a | is-not-a | regex | in | not in</a></span><span style="color: Gray"> --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.compose.include.filter.value" 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."><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> </filter> </include> <<a class="dict" href="valueset-definitions.html#ValueSet.compose.exclude" title="Exclude one or more codes from the value set."><b>exclude</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" 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"><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> </compose> <<a class="dict" href="valueset-definitions.html#ValueSet.expansion" title="When value set is an expansion."><b>expansion</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-5: Value set SHALL contain either a define, a compose, or an expansion element"><b><img alt="??" src="lock.png"/> 0..1</b></span> When value set is an expansion --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.expansion.identifier" 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."><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> <<a class="dict" href="valueset-definitions.html#ValueSet.expansion.timestamp" title="Time valueset expansion happened."><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> <<a class="dict" href="valueset-definitions.html#ValueSet.expansion.contains" title="Codes in the value set."><b>contains</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Codes in the value set --></span> <<a class="dict" href="valueset-definitions.html#ValueSet.expansion.contains.system" title="System value for the code."><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> <<a class="dict" href="valueset-definitions.html#ValueSet.expansion.contains.code" title="Code - if blank, this is not a choosable 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" title="Inv-6: SHALL have a code or a display"><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> <<a class="dict" href="valueset-definitions.html#ValueSet.expansion.contains.display" title="User display for the concept."><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" title="Inv-6: SHALL have a code or a display"><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> <<a class="dict" href="valueset-definitions.html#ValueSet.expansion.contains.contains" title="Codes contained in this concept."><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> </contains> </expansion> </ValueSet> </pre></div> </summary> </entry> <entry> <title>"conformance-base" - to help with system development</title> <id>http://hl7.org/fhir/conformance/conformance-base</id> <link href="http://hl7.org/implement/standards/fhir/conformance/conformance-base" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Conformance xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><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> </text> <identifier value="http://hl7.org/fhir/conformance-base"/> <version value="0.0.82.2943"/> <name value="Base FHIR Conformance Statement (Full)"/> <publisher value="FHIR Project Team"/> <telecom> <system value="url"/> <value value="http://hl7.org/fhir"/> </telecom> <description value="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 value="draft"/> <date value="2014-09-30T18:08:29.499+10:00"/> <fhirVersion value="0.0.82"/> <acceptUnknown value="false"/> <format value="xml"/> <format value="json"/> <rest> <mode value="server"/> <documentation value="All the functionality defined in FHIR"/> <resource> <type value="AdverseReaction"/> <profile> <reference value="http://hl7.org/fhir/AdverseReaction"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="substance"/> <definition value="http://hl7.org/fhir/profiles/AdverseReaction"/> <type value="reference"/> <documentation value="The name or code of the substance that produces the sensitivity"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/AdverseReaction"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/AdverseReaction"/> <type value="reference"/> <documentation value="The subject that the sensitivity is about"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/AdverseReaction"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/AdverseReaction"/> <type value="date"/> <documentation value="The date of the reaction"/> </searchParam> <searchParam> <name value="symptom"/> <definition value="http://hl7.org/fhir/profiles/AdverseReaction"/> <type value="token"/> <documentation value="One of the symptoms of the reaction"/> </searchParam> </resource> <resource> <type value="Alert"/> <profile> <reference value="http://hl7.org/fhir/Alert"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Alert"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/Alert"/> <type value="reference"/> <documentation value="The identity of a subject to list alerts for"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Alert"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> </resource> <resource> <type value="AllergyIntolerance"/> <profile> <reference value="http://hl7.org/fhir/AllergyIntolerance"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="substance"/> <definition value="http://hl7.org/fhir/profiles/AllergyIntolerance"/> <type value="reference"/> <documentation value="The name or code of the substance that produces the sensitivity"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/AllergyIntolerance"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/AllergyIntolerance"/> <type value="token"/> <documentation value="The status of the sensitivity"/> </searchParam> <searchParam> <name value="recorder"/> <definition value="http://hl7.org/fhir/profiles/AllergyIntolerance"/> <type value="reference"/> <documentation value="Who recorded the sensitivity"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/AllergyIntolerance"/> <type value="reference"/> <documentation value="The subject that the sensitivity is about"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/AllergyIntolerance"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/AllergyIntolerance"/> <type value="date"/> <documentation value="Recorded date/time."/> </searchParam> <searchParam> <name value="type"/> <definition value="http://hl7.org/fhir/profiles/AllergyIntolerance"/> <type value="token"/> <documentation value="The type of sensitivity"/> </searchParam> </resource> <resource> <type value="CarePlan"/> <profile> <reference value="http://hl7.org/fhir/CarePlan"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="activitycode"/> <definition value="http://hl7.org/fhir/profiles/CarePlan"/> <type value="token"/> <documentation value="Detail type of activity"/> </searchParam> <searchParam> <name value="patient"/> <definition value="http://hl7.org/fhir/profiles/CarePlan"/> <type value="reference"/> <documentation value="Who care plan is for"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/CarePlan"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="condition"/> <definition value="http://hl7.org/fhir/profiles/CarePlan"/> <type value="reference"/> <documentation value="Health issues this plan addresses"/> </searchParam> <searchParam> <name value="activitydetail"/> <definition value="http://hl7.org/fhir/profiles/CarePlan"/> <type value="reference"/> <documentation value="Activity details defined in specific resource"/> </searchParam> <searchParam> <name value="activitydate"/> <definition value="http://hl7.org/fhir/profiles/CarePlan"/> <type value="date"/> <documentation value="Specified date occurs within period specified by CarePlan.activity.timingSchedule"/> </searchParam> <searchParam> <name value="participant"/> <definition value="http://hl7.org/fhir/profiles/CarePlan"/> <type value="reference"/> <documentation value="Who is involved"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/CarePlan"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/CarePlan"/> <type value="date"/> <documentation value="Time period plan covers"/> </searchParam> </resource> <resource> <type value="Composition"/> <profile> <reference value="http://hl7.org/fhir/Composition"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="author"/> <definition value="http://hl7.org/fhir/profiles/Composition"/> <type value="reference"/> <documentation value="Who and/or what authored the composition"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Composition"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="attester"/> <definition value="http://hl7.org/fhir/profiles/Composition"/> <type value="reference"/> <documentation value="Who attested the composition"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/Composition"/> <type value="reference"/> <documentation value="Who and/or what the composition is about"/> </searchParam> <searchParam> <name value="section-content"/> <definition value="http://hl7.org/fhir/profiles/Composition"/> <type value="reference"/> <documentation value="The actual data for the section"/> </searchParam> <searchParam> <name value="context"/> <definition value="http://hl7.org/fhir/profiles/Composition"/> <type value="token"/> <documentation value="Code(s) that apply to the event being documented"/> </searchParam> <searchParam> <name value="class"/> <definition value="http://hl7.org/fhir/profiles/Composition"/> <type value="token"/> <documentation value="Categorization of Composition"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Composition"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="section-type"/> <definition value="http://hl7.org/fhir/profiles/Composition"/> <type value="token"/> <documentation value="Classification of section (recommended)"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/Composition"/> <type value="date"/> <documentation value="Composition editing time"/> </searchParam> <searchParam> <name value="type"/> <definition value="http://hl7.org/fhir/profiles/Composition"/> <type value="token"/> <documentation value="Kind of composition (LOINC if possible)"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/Composition"/> <type value="token"/> <documentation value="Logical identifier of composition (version-independent)"/> </searchParam> </resource> <resource> <type value="ConceptMap"/> <profile> <reference value="http://hl7.org/fhir/ConceptMap"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="dependson"/> <definition value="http://hl7.org/fhir/profiles/ConceptMap"/> <type value="token"/> <documentation value="Reference to element/field/valueset provides the context"/> </searchParam> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/ConceptMap"/> <type value="token"/> <documentation value="Status of the concept map"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/ConceptMap"/> <type value="date"/> <documentation value="The concept map publication date"/> </searchParam> <searchParam> <name value="version"/> <definition value="http://hl7.org/fhir/profiles/ConceptMap"/> <type value="token"/> <documentation value="The version identifier of the concept map"/> </searchParam> <searchParam> <name value="publisher"/> <definition value="http://hl7.org/fhir/profiles/ConceptMap"/> <type value="string"/> <documentation value="Name of the publisher of the concept map"/> </searchParam> <searchParam> <name value="product"/> <definition value="http://hl7.org/fhir/profiles/ConceptMap"/> <type value="token"/> <documentation value="Reference to element/field/valueset provides the context"/> </searchParam> <searchParam> <name value="system"/> <definition value="http://hl7.org/fhir/profiles/ConceptMap"/> <type value="token"/> <documentation value="The system for any destination concepts mapped by this map"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/ConceptMap"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="source"/> <definition value="http://hl7.org/fhir/profiles/ConceptMap"/> <type value="reference"/> <documentation value="The system for any concepts mapped by this concept map"/> </searchParam> <searchParam> <name value="description"/> <definition value="http://hl7.org/fhir/profiles/ConceptMap"/> <type value="string"/> <documentation value="Text search in the description of the concept map"/> </searchParam> <searchParam> <name value="name"/> <definition value="http://hl7.org/fhir/profiles/ConceptMap"/> <type value="string"/> <documentation value="Name of the concept map"/> </searchParam> <searchParam> <name value="target"/> <definition value="http://hl7.org/fhir/profiles/ConceptMap"/> <type value="reference"/> <documentation value="Provides context to the mappings"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/ConceptMap"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/ConceptMap"/> <type value="token"/> <documentation value="The identifier of the concept map"/> </searchParam> </resource> <resource> <type value="Condition"/> <profile> <reference value="http://hl7.org/fhir/Condition"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="asserter"/> <definition value="http://hl7.org/fhir/profiles/Condition"/> <type value="reference"/> <documentation value="Person who asserts this condition"/> </searchParam> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/Condition"/> <type value="token"/> <documentation value="The status of the condition"/> </searchParam> <searchParam> <name value="location"/> <definition value="http://hl7.org/fhir/profiles/Condition"/> <type value="token"/> <documentation value="Location - may include laterality"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/Condition"/> <type value="reference"/> <documentation value="Who has the condition?"/> </searchParam> <searchParam> <name value="onset"/> <definition value="http://hl7.org/fhir/profiles/Condition"/> <type value="date"/> <documentation value="When the Condition started (if started on a date)"/> </searchParam> <searchParam> <name value="evidence"/> <definition value="http://hl7.org/fhir/profiles/Condition"/> <type value="token"/> <documentation value="Manifestation/symptom"/> </searchParam> <searchParam> <name value="severity"/> <definition value="http://hl7.org/fhir/profiles/Condition"/> <type value="token"/> <documentation value="The severity of the condition"/> </searchParam> <searchParam> <name value="code"/> <definition value="http://hl7.org/fhir/profiles/Condition"/> <type value="token"/> <documentation value="Code for the condition"/> </searchParam> <searchParam> <name value="encounter"/> <definition value="http://hl7.org/fhir/profiles/Condition"/> <type value="reference"/> <documentation value="Encounter when condition first asserted"/> </searchParam> <searchParam> <name value="date-asserted"/> <definition value="http://hl7.org/fhir/profiles/Condition"/> <type value="date"/> <documentation value="When first detected/suspected/entered"/> </searchParam> <searchParam> <name value="stage"/> <definition value="http://hl7.org/fhir/profiles/Condition"/> <type value="token"/> <documentation value="Simple summary (disease specific)"/> </searchParam> <searchParam> <name value="related-code"/> <definition value="http://hl7.org/fhir/profiles/Condition"/> <type value="token"/> <documentation value="Relationship target by means of a predefined code"/> </searchParam> <searchParam> <name value="category"/> <definition value="http://hl7.org/fhir/profiles/Condition"/> <type value="token"/> <documentation value="The category of the condition"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Condition"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="related-item"/> <definition value="http://hl7.org/fhir/profiles/Condition"/> <type value="reference"/> <documentation value="Relationship target resource"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Condition"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> </resource> <resource> <type value="Conformance"/> <profile> <reference value="http://hl7.org/fhir/Conformance"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="token"/> <documentation value="The current status of the conformance statement"/> </searchParam> <searchParam> <name value="resource"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="token"/> <documentation value="Name of a resource mentioned in a conformance statement"/> </searchParam> <searchParam> <name value="security"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="token"/> <documentation value="Information about security of implementation"/> </searchParam> <searchParam> <name value="format"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="token"/> <documentation value="formats supported (xml | json | mime type)"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="date"/> <documentation value="The conformance statement publication date"/> </searchParam> <searchParam> <name value="mode"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="token"/> <documentation value="Mode - restful (server/client) or messaging (sender/receiver)"/> </searchParam> <searchParam> <name value="version"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="token"/> <documentation value="The version identifier of the conformance statement"/> </searchParam> <searchParam> <name value="publisher"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="string"/> <documentation value="Name of the publisher of the conformance statement"/> </searchParam> <searchParam> <name value="software"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="string"/> <documentation value="Part of a the name of a software application"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="description"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="string"/> <documentation value="Text search in the description of the conformance statement"/> </searchParam> <searchParam> <name value="event"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="token"/> <documentation value="Event code in a conformance statement"/> </searchParam> <searchParam> <name value="name"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="string"/> <documentation value="Name of the conformance statement"/> </searchParam> <searchParam> <name value="supported-profile"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="reference"/> <documentation value="Profiles supported by the system"/> </searchParam> <searchParam> <name value="fhirversion"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="token"/> <documentation value="The version of FHIR"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="token"/> <documentation value="The identifier of the conformance statement"/> </searchParam> <searchParam> <name value="profile"/> <definition value="http://hl7.org/fhir/profiles/Conformance"/> <type value="reference"/> <documentation value="A profile id invoked in a conformance statement"/> </searchParam> </resource> <resource> <type value="Device"/> <profile> <reference value="http://hl7.org/fhir/Device"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="organization"/> <definition value="http://hl7.org/fhir/profiles/Device"/> <type value="reference"/> <documentation value="The organization responsible for the device"/> </searchParam> <searchParam> <name value="model"/> <definition value="http://hl7.org/fhir/profiles/Device"/> <type value="string"/> <documentation value="The model of the device"/> </searchParam> <searchParam> <name value="patient"/> <definition value="http://hl7.org/fhir/profiles/Device"/> <type value="reference"/> <documentation value="Patient information, if the resource is affixed to a person"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Device"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="location"/> <definition value="http://hl7.org/fhir/profiles/Device"/> <type value="reference"/> <documentation value="A location, where the resource is found"/> </searchParam> <searchParam> <name value="manufacturer"/> <definition value="http://hl7.org/fhir/profiles/Device"/> <type value="string"/> <documentation value="The manufacturer of the device"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Device"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="udi"/> <definition value="http://hl7.org/fhir/profiles/Device"/> <type value="string"/> <documentation value="FDA Mandated Unique Device Identifier"/> </searchParam> <searchParam> <name value="type"/> <definition value="http://hl7.org/fhir/profiles/Device"/> <type value="token"/> <documentation value="The type of the device"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/Device"/> <type value="token"/> <documentation value="Instance id from manufacturer, owner and others"/> </searchParam> </resource> <resource> <type value="DeviceObservationReport"/> <profile> <reference value="http://hl7.org/fhir/DeviceObservationReport"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="observation"/> <definition value="http://hl7.org/fhir/profiles/DeviceObservationReport"/> <type value="reference"/> <documentation value="The data for the metric"/> </searchParam> <searchParam> <name value="source"/> <definition value="http://hl7.org/fhir/profiles/DeviceObservationReport"/> <type value="reference"/> <documentation value="Identifies/describes where the data came from"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/DeviceObservationReport"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/DeviceObservationReport"/> <type value="reference"/> <documentation value="Subject of the measurement"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/DeviceObservationReport"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="code"/> <definition value="http://hl7.org/fhir/profiles/DeviceObservationReport"/> <type value="token"/> <documentation value="The compatment code"/> </searchParam> <searchParam> <name value="channel"/> <definition value="http://hl7.org/fhir/profiles/DeviceObservationReport"/> <type value="token"/> <documentation value="The channel code"/> </searchParam> </resource> <resource> <type value="DiagnosticOrder"/> <profile> <reference value="http://hl7.org/fhir/DiagnosticOrder"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="orderer"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="reference"/> <documentation value="Who ordered the test"/> </searchParam> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="token"/> <documentation value="requested | received | accepted | in progress | review | completed | suspended | rejected | failed"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="reference"/> <documentation value="Who and/or what test is about"/> </searchParam> <searchParam> <name value="item-status"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="token"/> <documentation value="requested | received | accepted | in progress | review | completed | suspended | rejected | failed"/> </searchParam> <searchParam> <name value="event-status"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="token"/> <documentation value="requested | received | accepted | in progress | review | completed | suspended | rejected | failed"/> </searchParam> <searchParam> <name value="actor"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="reference"/> <documentation value="Who recorded or did this"/> </searchParam> <searchParam> <name value="code"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="token"/> <documentation value="Code to indicate the item (test or panel) being ordered"/> </searchParam> <searchParam> <name value="encounter"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="reference"/> <documentation value="The encounter that this diagnostic order is associated with"/> </searchParam> <searchParam> <name value="item-past-status"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="token"/> <documentation value="requested | received | accepted | in progress | review | completed | suspended | rejected | failed"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="bodysite"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="token"/> <documentation value="Location of requested test (if applicable)"/> </searchParam> <searchParam> <name value="item-date"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="date"/> <documentation value="The date at which the event happened"/> </searchParam> <searchParam> <name value="specimen"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="reference"/> <documentation value="If the whole order relates to specific specimens"/> </searchParam> <searchParam> <name value="event-status-date"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="composite"/> <documentation value="A combination of past-status and date"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="event-date"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="date"/> <documentation value="The date at which the event happened"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="token"/> <documentation value="Identifiers assigned to this order"/> </searchParam> <searchParam> <name value="item-status-date"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> <type value="composite"/> <documentation value="A combination of item-past-status and item-date"/> </searchParam> </resource> <resource> <type value="DiagnosticReport"/> <profile> <reference value="http://hl7.org/fhir/DiagnosticReport"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="result"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticReport"/> <type value="reference"/> <documentation value="Link to an atomic result (observation resource)"/> </searchParam> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticReport"/> <type value="token"/> <documentation value="The status of the report"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticReport"/> <type value="reference"/> <documentation value="The subject of the report"/> </searchParam> <searchParam> <name value="issued"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticReport"/> <type value="date"/> <documentation value="When the report was issued"/> </searchParam> <searchParam> <name value="diagnosis"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticReport"/> <type value="token"/> <documentation value="A coded diagnosis on the report"/> </searchParam> <searchParam> <name value="image"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticReport"/> <type value="reference"/> <documentation value="Reference to the image source"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticReport"/> <type value="date"/> <documentation value="The clinically relevant time of the report"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticReport"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="request"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticReport"/> <type value="reference"/> <documentation value="What was requested"/> </searchParam> <searchParam> <name value="specimen"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticReport"/> <type value="reference"/> <documentation value="The specimen details"/> </searchParam> <searchParam> <name value="name"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticReport"/> <type value="token"/> <documentation value="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)"/> </searchParam> <searchParam> <name value="service"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticReport"/> <type value="token"/> <documentation value="Which diagnostic discipline/department created the report"/> </searchParam> <searchParam> <name value="performer"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticReport"/> <type value="reference"/> <documentation value="Who was the source of the report (organization)"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticReport"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/DiagnosticReport"/> <type value="token"/> <documentation value="An identifier for the report"/> </searchParam> </resource> <resource> <type value="DocumentManifest"/> <profile> <reference value="http://hl7.org/fhir/DocumentManifest"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="supersedes"/> <definition value="http://hl7.org/fhir/profiles/DocumentManifest"/> <type value="reference"/> <documentation value="If this document manifest replaces another"/> </searchParam> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/DocumentManifest"/> <type value="token"/> <documentation value="current | superceded | entered in error"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/DocumentManifest"/> <type value="reference"/> <documentation value="The subject of the set of documents"/> </searchParam> <searchParam> <name value="type"/> <definition value="http://hl7.org/fhir/profiles/DocumentManifest"/> <type value="token"/> <documentation value="What kind of document set this is"/> </searchParam> <searchParam> <name value="recipient"/> <definition value="http://hl7.org/fhir/profiles/DocumentManifest"/> <type value="reference"/> <documentation value="Intended to get notified about this set of documents"/> </searchParam> <searchParam> <name value="content"/> <definition value="http://hl7.org/fhir/profiles/DocumentManifest"/> <type value="reference"/> <documentation value="Contents of this set of documents"/> </searchParam> <searchParam> <name value="author"/> <definition value="http://hl7.org/fhir/profiles/DocumentManifest"/> <type value="reference"/> <documentation value="Who and/or what authored the document"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/DocumentManifest"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="created"/> <definition value="http://hl7.org/fhir/profiles/DocumentManifest"/> <type value="date"/> <documentation value="When this document manifest created"/> </searchParam> <searchParam> <name value="description"/> <definition value="http://hl7.org/fhir/profiles/DocumentManifest"/> <type value="string"/> <documentation value="Human-readable description (title)"/> </searchParam> <searchParam> <name value="confidentiality"/> <definition value="http://hl7.org/fhir/profiles/DocumentManifest"/> <type value="token"/> <documentation value="Sensitivity of set of documents"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/DocumentManifest"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/DocumentManifest"/> <type value="token"/> <documentation value="Unique Identifier for the set of documents"/> </searchParam> </resource> <resource> <type value="DocumentReference"/> <profile> <reference value="http://hl7.org/fhir/DocumentReference"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="location"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="string"/> <documentation value="Where to access the document"/> </searchParam> <searchParam> <name value="indexed"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="date"/> <documentation value="When this document reference created"/> </searchParam> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="token"/> <documentation value="current | superceded | entered in error"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="reference"/> <documentation value="Who|what is the subject of the document"/> </searchParam> <searchParam> <name value="relatesto"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="reference"/> <documentation value="Target of the relationship"/> </searchParam> <searchParam> <name value="relation"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="token"/> <documentation value="replaces | transforms | signs | appends"/> </searchParam> <searchParam> <name value="class"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="token"/> <documentation value="Categorization of Document"/> </searchParam> <searchParam> <name value="format"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="token"/> <documentation value="Format/content rules for the document"/> </searchParam> <searchParam> <name value="period"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="date"/> <documentation value="Time of service that is being documented"/> </searchParam> <searchParam> <name value="type"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="token"/> <documentation value="What kind of document this is (LOINC if possible)"/> </searchParam> <searchParam> <name value="authenticator"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="reference"/> <documentation value="Who/What authenticated the document"/> </searchParam> <searchParam> <name value="size"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="number"/> <documentation value="Size of the document in bytes"/> </searchParam> <searchParam> <name value="relationship"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="composite"/> <documentation value="Combination of relation and relatesTo"/> </searchParam> <searchParam> <name value="author"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="reference"/> <documentation value="Who and/or what authored the document"/> </searchParam> <searchParam> <name value="custodian"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="reference"/> <documentation value="Org which maintains the document"/> </searchParam> <searchParam> <name value="facility"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="token"/> <documentation value="Kind of facility where patient was seen"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="created"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="date"/> <documentation value="Document creation time"/> </searchParam> <searchParam> <name value="event"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="token"/> <documentation value="Main Clinical Acts Documented"/> </searchParam> <searchParam> <name value="confidentiality"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="token"/> <documentation value="Sensitivity of source document"/> </searchParam> <searchParam> <name value="description"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="string"/> <documentation value="Human-readable description (title)"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="language"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="token"/> <documentation value="The marked primary language for the document"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/DocumentReference"/> <type value="token"/> <documentation value="Master Version Specific Identifier"/> </searchParam> </resource> <resource> <type value="Encounter"/> <profile> <reference value="http://hl7.org/fhir/Encounter"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Encounter"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="location"/> <definition value="http://hl7.org/fhir/profiles/Encounter"/> <type value="reference"/> <documentation value="Location the encounter takes place"/> </searchParam> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/Encounter"/> <type value="token"/> <documentation value="planned | in progress | onleave | finished | cancelled"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/Encounter"/> <type value="reference"/> <documentation value="The patient present at the encounter"/> </searchParam> <searchParam> <name value="indication"/> <definition value="http://hl7.org/fhir/profiles/Encounter"/> <type value="reference"/> <documentation value="Reason the encounter takes place (resource)"/> </searchParam> <searchParam> <name value="length"/> <definition value="http://hl7.org/fhir/profiles/Encounter"/> <type value="number"/> <documentation value="Length of encounter in days"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Encounter"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/Encounter"/> <type value="date"/> <documentation value="A date within the period the Encounter lasted"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/Encounter"/> <type value="token"/> <documentation value="Identifier(s) by which this encounter is known"/> </searchParam> <searchParam> <name value="location-period"/> <definition value="http://hl7.org/fhir/profiles/Encounter"/> <type value="date"/> <documentation value="Time period during which the patient was present at the location"/> </searchParam> </resource> <resource> <type value="FamilyHistory"/> <profile> <reference value="http://hl7.org/fhir/FamilyHistory"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/FamilyHistory"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/FamilyHistory"/> <type value="reference"/> <documentation value="The identity of a subject to list family history items for"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/FamilyHistory"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> </resource> <resource> <type value="Group"/> <profile> <reference value="http://hl7.org/fhir/Group"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="member"/> <definition value="http://hl7.org/fhir/profiles/Group"/> <type value="reference"/> <documentation value="Who is in group"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Group"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="characteristic-value"/> <definition value="http://hl7.org/fhir/profiles/Group"/> <type value="composite"/> <documentation value="A composite of both characteristic and value"/> </searchParam> <searchParam> <name value="value"/> <definition value="http://hl7.org/fhir/profiles/Group"/> <type value="token"/> <documentation value="Value held by characteristic"/> </searchParam> <searchParam> <name value="actual"/> <definition value="http://hl7.org/fhir/profiles/Group"/> <type value="token"/> <documentation value="Descriptive or actual"/> </searchParam> <searchParam> <name value="exclude"/> <definition value="http://hl7.org/fhir/profiles/Group"/> <type value="token"/> <documentation value="Group includes or excludes"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Group"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="code"/> <definition value="http://hl7.org/fhir/profiles/Group"/> <type value="token"/> <documentation value="The kind of resources contained"/> </searchParam> <searchParam> <name value="characteristic"/> <definition value="http://hl7.org/fhir/profiles/Group"/> <type value="token"/> <documentation value="Kind of characteristic"/> </searchParam> <searchParam> <name value="type"/> <definition value="http://hl7.org/fhir/profiles/Group"/> <type value="token"/> <documentation value="The type of resources the group contains"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/Group"/> <type value="token"/> <documentation value="Unique id"/> </searchParam> </resource> <resource> <type value="ImagingStudy"/> <profile> <reference value="http://hl7.org/fhir/ImagingStudy"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="uid"/> <definition value="http://hl7.org/fhir/profiles/ImagingStudy"/> <type value="token"/> <documentation value="Formal identifier for this instance (0008,0018)"/> </searchParam> <searchParam> <name value="series"/> <definition value="http://hl7.org/fhir/profiles/ImagingStudy"/> <type value="token"/> <documentation value="The series id for the image"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/ImagingStudy"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="bodysite"/> <definition value="http://hl7.org/fhir/profiles/ImagingStudy"/> <type value="token"/> <documentation value="Body part examined (Map from 0018,0015)"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/ImagingStudy"/> <type value="reference"/> <documentation value="Who the study is about"/> </searchParam> <searchParam> <name value="accession"/> <definition value="http://hl7.org/fhir/profiles/ImagingStudy"/> <type value="token"/> <documentation value="The accession id for the image"/> </searchParam> <searchParam> <name value="study"/> <definition value="http://hl7.org/fhir/profiles/ImagingStudy"/> <type value="token"/> <documentation value="The study id for the image"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/ImagingStudy"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="modality"/> <definition value="http://hl7.org/fhir/profiles/ImagingStudy"/> <type value="token"/> <documentation value="The modality of the image"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/ImagingStudy"/> <type value="date"/> <documentation value="The date the study was done was taken"/> </searchParam> <searchParam> <name value="dicom-class"/> <definition value="http://hl7.org/fhir/profiles/ImagingStudy"/> <type value="token"/> <documentation value="DICOM class type (0008,0016)"/> </searchParam> <searchParam> <name value="size"/> <definition value="http://hl7.org/fhir/profiles/ImagingStudy"/> <type value="number"/> <documentation value="The size of the image in MB - may include > or < in the value"/> </searchParam> </resource> <resource> <type value="Immunization"/> <profile> <reference value="http://hl7.org/fhir/Immunization"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="reaction"/> <definition value="http://hl7.org/fhir/profiles/Immunization"/> <type value="reference"/> <documentation value="Additional information on reaction"/> </searchParam> <searchParam> <name value="requester"/> <definition value="http://hl7.org/fhir/profiles/Immunization"/> <type value="reference"/> <documentation value="The practitioner who ordered the vaccination"/> </searchParam> <searchParam> <name value="dose-sequence"/> <definition value="http://hl7.org/fhir/profiles/Immunization"/> <type value="number"/> <documentation value="What dose number within series?"/> </searchParam> <searchParam> <name value="vaccine-type"/> <definition value="http://hl7.org/fhir/profiles/Immunization"/> <type value="token"/> <documentation value="Vaccine Product Type Administered"/> </searchParam> <searchParam> <name value="location"/> <definition value="http://hl7.org/fhir/profiles/Immunization"/> <type value="reference"/> <documentation value="The service delivery location or facility in which the vaccine was / was to be administered"/> </searchParam> <searchParam> <name value="reason"/> <definition value="http://hl7.org/fhir/profiles/Immunization"/> <type value="token"/> <documentation value="Why immunization occurred"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/Immunization"/> <type value="reference"/> <documentation value="The subject of the vaccination event / refusal"/> </searchParam> <searchParam> <name value="reaction-date"/> <definition value="http://hl7.org/fhir/profiles/Immunization"/> <type value="date"/> <documentation value="When did reaction start?"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/Immunization"/> <type value="date"/> <documentation value="Vaccination Administration / Refusal Date"/> </searchParam> <searchParam> <name value="lot-number"/> <definition value="http://hl7.org/fhir/profiles/Immunization"/> <type value="string"/> <documentation value="Vaccine Lot Number"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Immunization"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="manufacturer"/> <definition value="http://hl7.org/fhir/profiles/Immunization"/> <type value="reference"/> <documentation value="Vaccine Manufacturer"/> </searchParam> <searchParam> <name value="performer"/> <definition value="http://hl7.org/fhir/profiles/Immunization"/> <type value="reference"/> <documentation value="The practitioner who administered the vaccination"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Immunization"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="refused"/> <definition value="http://hl7.org/fhir/profiles/Immunization"/> <type value="token"/> <documentation value="Was immunization refused?"/> </searchParam> <searchParam> <name value="refusal-reason"/> <definition value="http://hl7.org/fhir/profiles/Immunization"/> <type value="token"/> <documentation value="Explanation of refusal / exemption"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/Immunization"/> <type value="token"/> <documentation value="Business identifier"/> </searchParam> </resource> <resource> <type value="ImmunizationRecommendation"/> <profile> <reference value="http://hl7.org/fhir/ImmunizationRecommendation"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="information"/> <definition value="http://hl7.org/fhir/profiles/ImmunizationRecommendation"/> <type value="reference"/> <documentation value="Patient observations supporting recommendation"/> </searchParam> <searchParam> <name value="dose-sequence"/> <definition value="http://hl7.org/fhir/profiles/ImmunizationRecommendation"/> <type value="token"/> <documentation value="Number of dose within sequence"/> </searchParam> <searchParam> <name value="support"/> <definition value="http://hl7.org/fhir/profiles/ImmunizationRecommendation"/> <type value="reference"/> <documentation value="Past immunizations supporting recommendation"/> </searchParam> <searchParam> <name value="vaccine-type"/> <definition value="http://hl7.org/fhir/profiles/ImmunizationRecommendation"/> <type value="token"/> <documentation value="Vaccine recommendation applies to"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/ImmunizationRecommendation"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/ImmunizationRecommendation"/> <type value="token"/> <documentation value="Vaccine administration status"/> </searchParam> <searchParam> <name value="dose-number"/> <definition value="http://hl7.org/fhir/profiles/ImmunizationRecommendation"/> <type value="number"/> <documentation value="Recommended dose number"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/ImmunizationRecommendation"/> <type value="reference"/> <documentation value="Who this profile is for"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/ImmunizationRecommendation"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/ImmunizationRecommendation"/> <type value="date"/> <documentation value="Date recommendation created"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/ImmunizationRecommendation"/> <type value="token"/> <documentation value="Business identifier"/> </searchParam> </resource> <resource> <type value="List"/> <profile> <reference value="http://hl7.org/fhir/List"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="source"/> <definition value="http://hl7.org/fhir/profiles/List"/> <type value="reference"/> <documentation value="Who and/or what defined the list contents"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/List"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/List"/> <type value="reference"/> <documentation value="If all resources have the same subject"/> </searchParam> <searchParam> <name value="item"/> <definition value="http://hl7.org/fhir/profiles/List"/> <type value="reference"/> <documentation value="Actual entry"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/List"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="code"/> <definition value="http://hl7.org/fhir/profiles/List"/> <type value="token"/> <documentation value="What the purpose of this list is"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/List"/> <type value="date"/> <documentation value="When the list was prepared"/> </searchParam> <searchParam> <name value="empty-reason"/> <definition value="http://hl7.org/fhir/profiles/List"/> <type value="token"/> <documentation value="Why list is empty"/> </searchParam> </resource> <resource> <type value="Location"/> <profile> <reference value="http://hl7.org/fhir/Location"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="near"/> <definition value="http://hl7.org/fhir/profiles/Location"/> <type value="token"/> <documentation value="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)"/> </searchParam> <searchParam> <name value="partof"/> <definition value="http://hl7.org/fhir/profiles/Location"/> <type value="reference"/> <documentation value="The location of which this location is a part"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Location"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/Location"/> <type value="token"/> <documentation value="Searches for locations with a specific kind of status"/> </searchParam> <searchParam> <name value="address"/> <definition value="http://hl7.org/fhir/profiles/Location"/> <type value="string"/> <documentation value="A (part of the) address of the location"/> </searchParam> <searchParam> <name value="name"/> <definition value="http://hl7.org/fhir/profiles/Location"/> <type value="string"/> <documentation value="A (portion of the) name of the location"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Location"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="near-distance"/> <definition value="http://hl7.org/fhir/profiles/Location"/> <type value="token"/> <documentation value="A distance quantity to limit the near search to locations within a specific distance"/> </searchParam> <searchParam> <name value="type"/> <definition value="http://hl7.org/fhir/profiles/Location"/> <type value="token"/> <documentation value="A code for the type of location"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/Location"/> <type value="token"/> <documentation value="Unique code or number identifying the location to its users"/> </searchParam> </resource> <resource> <type value="Media"/> <profile> <reference value="http://hl7.org/fhir/Media"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Media"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/Media"/> <type value="reference"/> <documentation value="Who/What this Media is a record of"/> </searchParam> <searchParam> <name value="subtype"/> <definition value="http://hl7.org/fhir/profiles/Media"/> <type value="token"/> <documentation value="The type of acquisition equipment/process"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Media"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="view"/> <definition value="http://hl7.org/fhir/profiles/Media"/> <type value="token"/> <documentation value="Imaging view e.g Lateral or Antero-posterior"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/Media"/> <type value="date"/> <documentation value="When the media was taken/recorded (end)"/> </searchParam> <searchParam> <name value="type"/> <definition value="http://hl7.org/fhir/profiles/Media"/> <type value="token"/> <documentation value="photo | video | audio"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/Media"/> <type value="token"/> <documentation value="Identifier(s) for the image"/> </searchParam> <searchParam> <name value="operator"/> <definition value="http://hl7.org/fhir/profiles/Media"/> <type value="reference"/> <documentation value="The person who generated the image"/> </searchParam> </resource> <resource> <type value="Medication"/> <profile> <reference value="http://hl7.org/fhir/Medication"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="content"/> <definition value="http://hl7.org/fhir/profiles/Medication"/> <type value="reference"/> <documentation value="A product in the package"/> </searchParam> <searchParam> <name value="form"/> <definition value="http://hl7.org/fhir/profiles/Medication"/> <type value="token"/> <documentation value="powder | tablets | carton +"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Medication"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="container"/> <definition value="http://hl7.org/fhir/profiles/Medication"/> <type value="token"/> <documentation value="E.g. box, vial, blister-pack"/> </searchParam> <searchParam> <name value="manufacturer"/> <definition value="http://hl7.org/fhir/profiles/Medication"/> <type value="reference"/> <documentation value="Manufacturer of the item"/> </searchParam> <searchParam> <name value="name"/> <definition value="http://hl7.org/fhir/profiles/Medication"/> <type value="string"/> <documentation value="Common / Commercial name"/> </searchParam> <searchParam> <name value="ingredient"/> <definition value="http://hl7.org/fhir/profiles/Medication"/> <type value="reference"/> <documentation value="The product contained"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Medication"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="code"/> <definition value="http://hl7.org/fhir/profiles/Medication"/> <type value="token"/> <documentation value="Codes that identify this medication"/> </searchParam> </resource> <resource> <type value="MedicationAdministration"/> <profile> <reference value="http://hl7.org/fhir/MedicationAdministration"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="medication"/> <definition value="http://hl7.org/fhir/profiles/MedicationAdministration"/> <type value="reference"/> <documentation value="Return administrations of this medication"/> </searchParam> <searchParam> <name value="patient"/> <definition value="http://hl7.org/fhir/profiles/MedicationAdministration"/> <type value="reference"/> <documentation value="The identity of a patient to list administrations for"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/MedicationAdministration"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/MedicationAdministration"/> <type value="token"/> <documentation value="MedicationAdministration event status (for example one of active/paused/completed/nullified)"/> </searchParam> <searchParam> <name value="prescription"/> <definition value="http://hl7.org/fhir/profiles/MedicationAdministration"/> <type value="reference"/> <documentation value="The identity of a prescription to list administrations from"/> </searchParam> <searchParam> <name value="device"/> <definition value="http://hl7.org/fhir/profiles/MedicationAdministration"/> <type value="reference"/> <documentation value="Return administrations with this administration device identity"/> </searchParam> <searchParam> <name value="notgiven"/> <definition value="http://hl7.org/fhir/profiles/MedicationAdministration"/> <type value="token"/> <documentation value="Administrations that were not made"/> </searchParam> <searchParam> <name value="whengiven"/> <definition value="http://hl7.org/fhir/profiles/MedicationAdministration"/> <type value="date"/> <documentation value="Date of administration"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/MedicationAdministration"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="encounter"/> <definition value="http://hl7.org/fhir/profiles/MedicationAdministration"/> <type value="reference"/> <documentation value="Return administrations that share this encounter"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/MedicationAdministration"/> <type value="token"/> <documentation value="Return administrations with this external identity"/> </searchParam> </resource> <resource> <type value="MedicationDispense"/> <profile> <reference value="http://hl7.org/fhir/MedicationDispense"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="medication"/> <definition value="http://hl7.org/fhir/profiles/MedicationDispense"/> <type value="reference"/> <documentation value="Returns dispenses of this medicine"/> </searchParam> <searchParam> <name value="prescription"/> <definition value="http://hl7.org/fhir/profiles/MedicationDispense"/> <type value="reference"/> <documentation value="The identity of a prescription to list dispenses from"/> </searchParam> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/MedicationDispense"/> <type value="token"/> <documentation value="Status of the dispense"/> </searchParam> <searchParam> <name value="type"/> <definition value="http://hl7.org/fhir/profiles/MedicationDispense"/> <type value="token"/> <documentation value="Return all dispenses of a specific type"/> </searchParam> <searchParam> <name value="destination"/> <definition value="http://hl7.org/fhir/profiles/MedicationDispense"/> <type value="reference"/> <documentation value="Return dispenses that should be sent to a secific destination"/> </searchParam> <searchParam> <name value="patient"/> <definition value="http://hl7.org/fhir/profiles/MedicationDispense"/> <type value="reference"/> <documentation value="The identity of a patient to list dispenses for"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/MedicationDispense"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="responsibleparty"/> <definition value="http://hl7.org/fhir/profiles/MedicationDispense"/> <type value="reference"/> <documentation value="Return all dispenses with the specified responsible party"/> </searchParam> <searchParam> <name value="dispenser"/> <definition value="http://hl7.org/fhir/profiles/MedicationDispense"/> <type value="reference"/> <documentation value="Return all dispenses performed by a specific indiividual"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/MedicationDispense"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/MedicationDispense"/> <type value="token"/> <documentation value="Return dispenses with this external identity"/> </searchParam> <searchParam> <name value="whenhandedover"/> <definition value="http://hl7.org/fhir/profiles/MedicationDispense"/> <type value="date"/> <documentation value="Date when medication handed over to patient (outpatient setting), or supplied to ward or clinic (inpatient setting)"/> </searchParam> <searchParam> <name value="whenprepared"/> <definition value="http://hl7.org/fhir/profiles/MedicationDispense"/> <type value="date"/> <documentation value="Date when medication prepared"/> </searchParam> </resource> <resource> <type value="MedicationPrescription"/> <profile> <reference value="http://hl7.org/fhir/MedicationPrescription"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="medication"/> <definition value="http://hl7.org/fhir/profiles/MedicationPrescription"/> <type value="reference"/> <documentation value="Code for medicine or text in medicine name"/> </searchParam> <searchParam> <name value="datewritten"/> <definition value="http://hl7.org/fhir/profiles/MedicationPrescription"/> <type value="date"/> <documentation value="Return prescriptions written on this date"/> </searchParam> <searchParam> <name value="patient"/> <definition value="http://hl7.org/fhir/profiles/MedicationPrescription"/> <type value="reference"/> <documentation value="The identity of a patient to list dispenses for"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/MedicationPrescription"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/MedicationPrescription"/> <type value="token"/> <documentation value="Status of the prescription"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/MedicationPrescription"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="encounter"/> <definition value="http://hl7.org/fhir/profiles/MedicationPrescription"/> <type value="reference"/> <documentation value="Return prescriptions with this encounter identity"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/MedicationPrescription"/> <type value="token"/> <documentation value="Return prescriptions with this external identity"/> </searchParam> </resource> <resource> <type value="MedicationStatement"/> <profile> <reference value="http://hl7.org/fhir/MedicationStatement"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="medication"/> <definition value="http://hl7.org/fhir/profiles/MedicationStatement"/> <type value="reference"/> <documentation value="Code for medicine or text in medicine name"/> </searchParam> <searchParam> <name value="patient"/> <definition value="http://hl7.org/fhir/profiles/MedicationStatement"/> <type value="reference"/> <documentation value="The identity of a patient to list administrations for"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/MedicationStatement"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="device"/> <definition value="http://hl7.org/fhir/profiles/MedicationStatement"/> <type value="reference"/> <documentation value="Return administrations with this administration device identity"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/MedicationStatement"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="when-given"/> <definition value="http://hl7.org/fhir/profiles/MedicationStatement"/> <type value="date"/> <documentation value="Date of administration"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/MedicationStatement"/> <type value="token"/> <documentation value="Return administrations with this external identity"/> </searchParam> </resource> <resource> <type value="MessageHeader"/> <profile> <reference value="http://hl7.org/fhir/MessageHeader"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/MessageHeader"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/MessageHeader"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> </resource> <resource> <type value="Observation"/> <profile> <reference value="http://hl7.org/fhir/Observation"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="value-string"/> <definition value="http://hl7.org/fhir/profiles/Observation"/> <type value="string"/> <documentation value="The value of the observation, if the value is a string, and also searches in CodeableConcept.text"/> </searchParam> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/Observation"/> <type value="token"/> <documentation value="The status of the observation"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/Observation"/> <type value="reference"/> <documentation value="The subject that the observation is about"/> </searchParam> <searchParam> <name value="value-concept"/> <definition value="http://hl7.org/fhir/profiles/Observation"/> <type value="token"/> <documentation value="The value of the observation, if the value is a CodeableConcept"/> </searchParam> <searchParam> <name value="reliability"/> <definition value="http://hl7.org/fhir/profiles/Observation"/> <type value="token"/> <documentation value="The reliability of the observation"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/Observation"/> <type value="date"/> <documentation value="Obtained date/time. If the obtained element is a period, a date that falls in the period"/> </searchParam> <searchParam> <name value="name-value-[x]"/> <definition value="http://hl7.org/fhir/profiles/Observation"/> <type value="composite"/> <documentation value="Both name and one of the value parameters"/> </searchParam> <searchParam> <name value="related-target"/> <definition value="http://hl7.org/fhir/profiles/Observation"/> <type value="reference"/> <documentation value="Observation that is related to this one"/> </searchParam> <searchParam> <name value="related"/> <definition value="http://hl7.org/fhir/profiles/Observation"/> <type value="composite"/> <documentation value="Related Observations - search on related-type and related-target together"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Observation"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="specimen"/> <definition value="http://hl7.org/fhir/profiles/Observation"/> <type value="reference"/> <documentation value="Specimen used for this observation"/> </searchParam> <searchParam> <name value="name"/> <definition value="http://hl7.org/fhir/profiles/Observation"/> <type value="token"/> <documentation value="The name of the observation type"/> </searchParam> <searchParam> <name value="related-type"/> <definition value="http://hl7.org/fhir/profiles/Observation"/> <type value="token"/> <documentation value="has-component | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by"/> </searchParam> <searchParam> <name value="performer"/> <definition value="http://hl7.org/fhir/profiles/Observation"/> <type value="reference"/> <documentation value="Who and/or what performed the observation"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Observation"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="value-quantity"/> <definition value="http://hl7.org/fhir/profiles/Observation"/> <type value="quantity"/> <documentation value="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)"/> </searchParam> <searchParam> <name value="value-date"/> <definition value="http://hl7.org/fhir/profiles/Observation"/> <type value="date"/> <documentation value="The value of the observation, if the value is a Period"/> </searchParam> </resource> <resource> <type value="OperationOutcome"/> <profile> <reference value="http://hl7.org/fhir/OperationOutcome"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/OperationOutcome"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/OperationOutcome"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> </resource> <resource> <type value="Order"/> <profile> <reference value="http://hl7.org/fhir/Order"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="authority"/> <definition value="http://hl7.org/fhir/profiles/Order"/> <type value="reference"/> <documentation value="If required by policy"/> </searchParam> <searchParam> <name value="detail"/> <definition value="http://hl7.org/fhir/profiles/Order"/> <type value="reference"/> <documentation value="What action is being ordered"/> </searchParam> <searchParam> <name value="source"/> <definition value="http://hl7.org/fhir/profiles/Order"/> <type value="reference"/> <documentation value="Who initiated the order"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Order"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/Order"/> <type value="reference"/> <documentation value="Patient this order is about"/> </searchParam> <searchParam> <name value="when"/> <definition value="http://hl7.org/fhir/profiles/Order"/> <type value="date"/> <documentation value="A formal schedule"/> </searchParam> <searchParam> <name value="target"/> <definition value="http://hl7.org/fhir/profiles/Order"/> <type value="reference"/> <documentation value="Who is intended to fulfill the order"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Order"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="when_code"/> <definition value="http://hl7.org/fhir/profiles/Order"/> <type value="token"/> <documentation value="Code specifies when request should be done. The code may simply be a priority code"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/Order"/> <type value="date"/> <documentation value="When the order was made"/> </searchParam> </resource> <resource> <type value="OrderResponse"/> <profile> <reference value="http://hl7.org/fhir/OrderResponse"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/OrderResponse"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="fulfillment"/> <definition value="http://hl7.org/fhir/profiles/OrderResponse"/> <type value="reference"/> <documentation value="Details of the outcome of performing the order"/> </searchParam> <searchParam> <name value="request"/> <definition value="http://hl7.org/fhir/profiles/OrderResponse"/> <type value="reference"/> <documentation value="The order that this is a response to"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/OrderResponse"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="code"/> <definition value="http://hl7.org/fhir/profiles/OrderResponse"/> <type value="token"/> <documentation value="pending | review | rejected | error | accepted | cancelled | replaced | aborted | complete"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/OrderResponse"/> <type value="date"/> <documentation value="When the response was made"/> </searchParam> <searchParam> <name value="who"/> <definition value="http://hl7.org/fhir/profiles/OrderResponse"/> <type value="reference"/> <documentation value="Who made the response"/> </searchParam> </resource> <resource> <type value="Organization"/> <profile> <reference value="http://hl7.org/fhir/Organization"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="phonetic"/> <definition value="http://hl7.org/fhir/profiles/Organization"/> <type value="string"/> <documentation value="A portion of the organization's name using some kind of phonetic matching algorithm"/> </searchParam> <searchParam> <name value="partof"/> <definition value="http://hl7.org/fhir/profiles/Organization"/> <type value="reference"/> <documentation value="Search all organizations that are part of the given organization"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Organization"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="name"/> <definition value="http://hl7.org/fhir/profiles/Organization"/> <type value="string"/> <documentation value="A portion of the organization's name"/> </searchParam> <searchParam> <name value="active"/> <definition value="http://hl7.org/fhir/profiles/Organization"/> <type value="token"/> <documentation value="Whether the organization's record is active"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Organization"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="type"/> <definition value="http://hl7.org/fhir/profiles/Organization"/> <type value="token"/> <documentation value="A code for the type of organization"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/Organization"/> <type value="token"/> <documentation value="Any identifier for the organization (not the accreditation issuer's identifier)"/> </searchParam> </resource> <resource> <type value="Other"/> <profile> <reference value="http://hl7.org/fhir/Other"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Other"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="created"/> <definition value="http://hl7.org/fhir/profiles/Other"/> <type value="date"/> <documentation value="When created"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/Other"/> <type value="reference"/> <documentation value="Identifies the"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Other"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="code"/> <definition value="http://hl7.org/fhir/profiles/Other"/> <type value="token"/> <documentation value="Kind of Resource"/> </searchParam> </resource> <resource> <type value="Patient"/> <profile> <reference value="http://hl7.org/fhir/Patient"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="animal-breed"/> <definition value="http://hl7.org/fhir/profiles/Patient"/> <type value="token"/> <documentation value="The breed for animal patients"/> </searchParam> <searchParam> <name value="phonetic"/> <definition value="http://hl7.org/fhir/profiles/Patient"/> <type value="string"/> <documentation value="A portion of either family or given name using some kind of phonetic matching algorithm"/> </searchParam> <searchParam> <name value="link"/> <definition value="http://hl7.org/fhir/profiles/Patient"/> <type value="reference"/> <documentation value="All patients linked to the given patient"/> </searchParam> <searchParam> <name value="provider"/> <definition value="http://hl7.org/fhir/profiles/Patient"/> <type value="reference"/> <documentation value="The organization at which this person is a patient"/> </searchParam> <searchParam> <name value="animal-species"/> <definition value="http://hl7.org/fhir/profiles/Patient"/> <type value="token"/> <documentation value="The species for animal patients"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Patient"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="given"/> <definition value="http://hl7.org/fhir/profiles/Patient"/> <type value="string"/> <documentation value="A portion of the given name of the patient"/> </searchParam> <searchParam> <name value="address"/> <definition value="http://hl7.org/fhir/profiles/Patient"/> <type value="string"/> <documentation value="An address in any kind of address/part of the patient"/> </searchParam> <searchParam> <name value="family"/> <definition value="http://hl7.org/fhir/profiles/Patient"/> <type value="string"/> <documentation value="A portion of the family name of the patient"/> </searchParam> <searchParam> <name value="name"/> <definition value="http://hl7.org/fhir/profiles/Patient"/> <type value="string"/> <documentation value="A portion of either family or given name of the patient"/> </searchParam> <searchParam> <name value="telecom"/> <definition value="http://hl7.org/fhir/profiles/Patient"/> <type value="string"/> <documentation value="The value in any kind of telecom details of the patient"/> </searchParam> <searchParam> <name value="birthdate"/> <definition value="http://hl7.org/fhir/profiles/Patient"/> <type value="date"/> <documentation value="The patient's date of birth"/> </searchParam> <searchParam> <name value="active"/> <definition value="http://hl7.org/fhir/profiles/Patient"/> <type value="token"/> <documentation value="Whether the patient record is active"/> </searchParam> <searchParam> <name value="gender"/> <definition value="http://hl7.org/fhir/profiles/Patient"/> <type value="token"/> <documentation value="Gender of the patient"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Patient"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="language"/> <definition value="http://hl7.org/fhir/profiles/Patient"/> <type value="token"/> <documentation value="Language code (irrespective of use value)"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/Patient"/> <type value="token"/> <documentation value="A patient identifier"/> </searchParam> </resource> <resource> <type value="Practitioner"/> <profile> <reference value="http://hl7.org/fhir/Practitioner"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="organization"/> <definition value="http://hl7.org/fhir/profiles/Practitioner"/> <type value="reference"/> <documentation value="The identity of the organization the practitioner represents / acts on behalf of"/> </searchParam> <searchParam> <name value="phonetic"/> <definition value="http://hl7.org/fhir/profiles/Practitioner"/> <type value="string"/> <documentation value="A portion of either family or given name using some kind of phonetic matching algorithm"/> </searchParam> <searchParam> <name value="given"/> <definition value="http://hl7.org/fhir/profiles/Practitioner"/> <type value="string"/> <documentation value="A portion of the given name"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Practitioner"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="address"/> <definition value="http://hl7.org/fhir/profiles/Practitioner"/> <type value="string"/> <documentation value="An address in any kind of address/part"/> </searchParam> <searchParam> <name value="family"/> <definition value="http://hl7.org/fhir/profiles/Practitioner"/> <type value="string"/> <documentation value="A portion of the family name"/> </searchParam> <searchParam> <name value="name"/> <definition value="http://hl7.org/fhir/profiles/Practitioner"/> <type value="string"/> <documentation value="A portion of either family or given name"/> </searchParam> <searchParam> <name value="telecom"/> <definition value="http://hl7.org/fhir/profiles/Practitioner"/> <type value="string"/> <documentation value="The value in any kind of contact"/> </searchParam> <searchParam> <name value="gender"/> <definition value="http://hl7.org/fhir/profiles/Practitioner"/> <type value="token"/> <documentation value="Gender of the practitioner"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Practitioner"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/Practitioner"/> <type value="token"/> <documentation value="A practitioner's Identifier"/> </searchParam> </resource> <resource> <type value="Procedure"/> <profile> <reference value="http://hl7.org/fhir/Procedure"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Procedure"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/Procedure"/> <type value="reference"/> <documentation value="The identity of a patient to list procedures for"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Procedure"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/Procedure"/> <type value="date"/> <documentation value="The date the procedure was performed on"/> </searchParam> <searchParam> <name value="type"/> <definition value="http://hl7.org/fhir/profiles/Procedure"/> <type value="token"/> <documentation value="Type of procedure"/> </searchParam> </resource> <resource> <type value="Profile"/> <profile> <reference value="http://hl7.org/fhir/Profile"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/Profile"/> <type value="token"/> <documentation value="The current status of the profile"/> </searchParam> <searchParam> <name value="code"/> <definition value="http://hl7.org/fhir/profiles/Profile"/> <type value="token"/> <documentation value="A code for the profile in the format uri::code (server may choose to do subsumption)"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/Profile"/> <type value="date"/> <documentation value="The profile publication date"/> </searchParam> <searchParam> <name value="type"/> <definition value="http://hl7.org/fhir/profiles/Profile"/> <type value="token"/> <documentation value="Type of resource that is constrained in the profile"/> </searchParam> <searchParam> <name value="version"/> <definition value="http://hl7.org/fhir/profiles/Profile"/> <type value="token"/> <documentation value="The version identifier of the profile"/> </searchParam> <searchParam> <name value="publisher"/> <definition value="http://hl7.org/fhir/profiles/Profile"/> <type value="string"/> <documentation value="Name of the publisher of the profile"/> </searchParam> <searchParam> <name value="extension"/> <definition value="http://hl7.org/fhir/profiles/Profile"/> <type value="token"/> <documentation value="An extension code (use or definition)"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Profile"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="valueset"/> <definition value="http://hl7.org/fhir/profiles/Profile"/> <type value="reference"/> <documentation value="A vocabulary binding code"/> </searchParam> <searchParam> <name value="description"/> <definition value="http://hl7.org/fhir/profiles/Profile"/> <type value="string"/> <documentation value="Text search in the description of the profile"/> </searchParam> <searchParam> <name value="name"/> <definition value="http://hl7.org/fhir/profiles/Profile"/> <type value="string"/> <documentation value="Name of the profile"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Profile"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/Profile"/> <type value="token"/> <documentation value="The identifier of the profile"/> </searchParam> </resource> <resource> <type value="Provenance"/> <profile> <reference value="http://hl7.org/fhir/Provenance"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Provenance"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="location"/> <definition value="http://hl7.org/fhir/profiles/Provenance"/> <type value="reference"/> <documentation value="Where the activity occurred, if relevant"/> </searchParam> <searchParam> <name value="start"/> <definition value="http://hl7.org/fhir/profiles/Provenance"/> <type value="date"/> <documentation value="Starting time with inclusive boundary"/> </searchParam> <searchParam> <name value="partytype"/> <definition value="http://hl7.org/fhir/profiles/Provenance"/> <type value="token"/> <documentation value="e.g. Resource | Person | Application | Record | Document +"/> </searchParam> <searchParam> <name value="target"/> <definition value="http://hl7.org/fhir/profiles/Provenance"/> <type value="reference"/> <documentation value="Target resource(s) (usually version specific)"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Provenance"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="party"/> <definition value="http://hl7.org/fhir/profiles/Provenance"/> <type value="token"/> <documentation value="Identity of agent (urn or url)"/> </searchParam> <searchParam> <name value="end"/> <definition value="http://hl7.org/fhir/profiles/Provenance"/> <type value="date"/> <documentation value="End time with inclusive boundary, if not ongoing"/> </searchParam> </resource> <resource> <type value="Query"/> <profile> <reference value="http://hl7.org/fhir/Query"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="response"/> <definition value="http://hl7.org/fhir/profiles/Query"/> <type value="token"/> <documentation value="Links response to source query"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Query"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Query"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/Query"/> <type value="token"/> <documentation value="Links query and its response(s)"/> </searchParam> </resource> <resource> <type value="Questionnaire"/> <profile> <reference value="http://hl7.org/fhir/Questionnaire"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="author"/> <definition value="http://hl7.org/fhir/profiles/Questionnaire"/> <type value="reference"/> <documentation value="The author of the questionnaire"/> </searchParam> <searchParam> <name value="authored"/> <definition value="http://hl7.org/fhir/profiles/Questionnaire"/> <type value="date"/> <documentation value="When the questionnaire was authored"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Questionnaire"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/Questionnaire"/> <type value="token"/> <documentation value="The status of the questionnaire"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/Questionnaire"/> <type value="reference"/> <documentation value="The subject of the questionnaire"/> </searchParam> <searchParam> <name value="name"/> <definition value="http://hl7.org/fhir/profiles/Questionnaire"/> <type value="token"/> <documentation value="Name of the questionnaire"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Questionnaire"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="encounter"/> <definition value="http://hl7.org/fhir/profiles/Questionnaire"/> <type value="reference"/> <documentation value="Encounter during which questionnaire was authored"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/Questionnaire"/> <type value="token"/> <documentation value="An identifier for the questionnaire"/> </searchParam> </resource> <resource> <type value="RelatedPerson"/> <profile> <reference value="http://hl7.org/fhir/RelatedPerson"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="patient"/> <definition value="http://hl7.org/fhir/profiles/RelatedPerson"/> <type value="reference"/> <documentation value="The patient this person is related to"/> </searchParam> <searchParam> <name value="phonetic"/> <definition value="http://hl7.org/fhir/profiles/RelatedPerson"/> <type value="string"/> <documentation value="A portion of name using some kind of phonetic matching algorithm"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/RelatedPerson"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="address"/> <definition value="http://hl7.org/fhir/profiles/RelatedPerson"/> <type value="string"/> <documentation value="An address in any kind of address/part"/> </searchParam> <searchParam> <name value="name"/> <definition value="http://hl7.org/fhir/profiles/RelatedPerson"/> <type value="string"/> <documentation value="A portion of name in any name part"/> </searchParam> <searchParam> <name value="telecom"/> <definition value="http://hl7.org/fhir/profiles/RelatedPerson"/> <type value="string"/> <documentation value="The value in any kind of contact"/> </searchParam> <searchParam> <name value="gender"/> <definition value="http://hl7.org/fhir/profiles/RelatedPerson"/> <type value="token"/> <documentation value="Gender of the person"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/RelatedPerson"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/RelatedPerson"/> <type value="token"/> <documentation value="A patient Identifier"/> </searchParam> </resource> <resource> <type value="SecurityEvent"/> <profile> <reference value="http://hl7.org/fhir/SecurityEvent"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="site"/> <definition value="http://hl7.org/fhir/profiles/SecurityEvent"/> <type value="token"/> <documentation value="Logical source location within the enterprise"/> </searchParam> <searchParam> <name value="desc"/> <definition value="http://hl7.org/fhir/profiles/SecurityEvent"/> <type value="string"/> <documentation value="Instance-specific descriptor for Object"/> </searchParam> <searchParam> <name value="type"/> <definition value="http://hl7.org/fhir/profiles/SecurityEvent"/> <type value="token"/> <documentation value="Type/identifier of event"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/SecurityEvent"/> <type value="date"/> <documentation value="Time when the event occurred on source"/> </searchParam> <searchParam> <name value="reference"/> <definition value="http://hl7.org/fhir/profiles/SecurityEvent"/> <type value="reference"/> <documentation value="Specific instance of resource (e.g. versioned)"/> </searchParam> <searchParam> <name value="identity"/> <definition value="http://hl7.org/fhir/profiles/SecurityEvent"/> <type value="token"/> <documentation value="Specific instance of object (e.g. versioned)"/> </searchParam> <searchParam> <name value="altid"/> <definition value="http://hl7.org/fhir/profiles/SecurityEvent"/> <type value="token"/> <documentation value="Alternative User id e.g. authentication"/> </searchParam> <searchParam> <name value="patientid"/> <definition value="http://hl7.org/fhir/profiles/SecurityEvent"/> <type value="token"/> <documentation value="The id of the patient (one of multiple kinds of participations)"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/SecurityEvent"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="source"/> <definition value="http://hl7.org/fhir/profiles/SecurityEvent"/> <type value="token"/> <documentation value="The id of source where event originated"/> </searchParam> <searchParam> <name value="address"/> <definition value="http://hl7.org/fhir/profiles/SecurityEvent"/> <type value="token"/> <documentation value="Identifier for the network access point of the user device"/> </searchParam> <searchParam> <name value="subtype"/> <definition value="http://hl7.org/fhir/profiles/SecurityEvent"/> <type value="token"/> <documentation value="More specific type/id for the event"/> </searchParam> <searchParam> <name value="name"/> <definition value="http://hl7.org/fhir/profiles/SecurityEvent"/> <type value="string"/> <documentation value="Human-meaningful name for the user"/> </searchParam> <searchParam> <name value="action"/> <definition value="http://hl7.org/fhir/profiles/SecurityEvent"/> <type value="token"/> <documentation value="Type of action performed during the event"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/SecurityEvent"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="object-type"/> <definition value="http://hl7.org/fhir/profiles/SecurityEvent"/> <type value="token"/> <documentation value="Object type being audited"/> </searchParam> <searchParam> <name value="user"/> <definition value="http://hl7.org/fhir/profiles/SecurityEvent"/> <type value="token"/> <documentation value="Unique identifier for the user"/> </searchParam> </resource> <resource> <type value="Specimen"/> <profile> <reference value="http://hl7.org/fhir/Specimen"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Specimen"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="subject"/> <definition value="http://hl7.org/fhir/profiles/Specimen"/> <type value="reference"/> <documentation value="The subject of the specimen"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Specimen"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> </resource> <resource> <type value="Substance"/> <profile> <reference value="http://hl7.org/fhir/Substance"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="substance"/> <definition value="http://hl7.org/fhir/profiles/Substance"/> <type value="reference"/> <documentation value="A component of the substance"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Substance"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="quantity"/> <definition value="http://hl7.org/fhir/profiles/Substance"/> <type value="number"/> <documentation value="Amount of substance in the package"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Substance"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="type"/> <definition value="http://hl7.org/fhir/profiles/Substance"/> <type value="token"/> <documentation value="The type of the substance"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/Substance"/> <type value="token"/> <documentation value="Identifier of the package/container"/> </searchParam> <searchParam> <name value="expiry"/> <definition value="http://hl7.org/fhir/profiles/Substance"/> <type value="date"/> <documentation value="When no longer valid to use"/> </searchParam> </resource> <resource> <type value="Supply"/> <profile> <reference value="http://hl7.org/fhir/Supply"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="patient"/> <definition value="http://hl7.org/fhir/profiles/Supply"/> <type value="reference"/> <documentation value="Patient for whom the item is supplied"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/Supply"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/Supply"/> <type value="token"/> <documentation value="requested | dispensed | received | failed | cancelled"/> </searchParam> <searchParam> <name value="dispenseid"/> <definition value="http://hl7.org/fhir/profiles/Supply"/> <type value="token"/> <documentation value="External identifier"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/Supply"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/Supply"/> <type value="token"/> <documentation value="Unique identifier"/> </searchParam> <searchParam> <name value="supplier"/> <definition value="http://hl7.org/fhir/profiles/Supply"/> <type value="reference"/> <documentation value="Dispenser"/> </searchParam> <searchParam> <name value="kind"/> <definition value="http://hl7.org/fhir/profiles/Supply"/> <type value="token"/> <documentation value="The kind of supply (central, non-stock, etc)"/> </searchParam> <searchParam> <name value="dispensestatus"/> <definition value="http://hl7.org/fhir/profiles/Supply"/> <type value="token"/> <documentation value="in progress | dispensed | abandoned"/> </searchParam> </resource> <resource> <type value="ValueSet"/> <profile> <reference value="http://hl7.org/fhir/ValueSet"/> </profile> <operation> <code value="read"/> </operation> <operation> <code value="vread"/> </operation> <operation> <code value="update"/> </operation> <operation> <code value="delete"/> </operation> <operation> <code value="history-instance"/> </operation> <operation> <code value="validate"/> </operation> <operation> <code value="history-type"/> </operation> <operation> <code value="create"/> </operation> <operation> <code value="search-type"/> </operation> <searchParam> <name value="system"/> <definition value="http://hl7.org/fhir/profiles/ValueSet"/> <type value="token"/> <documentation value="The system for any codes defined by this value set"/> </searchParam> <searchParam> <name value="_id"/> <definition value="http://hl7.org/fhir/profiles/ValueSet"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="status"/> <definition value="http://hl7.org/fhir/profiles/ValueSet"/> <type value="token"/> <documentation value="The status of the value set"/> </searchParam> <searchParam> <name value="description"/> <definition value="http://hl7.org/fhir/profiles/ValueSet"/> <type value="string"/> <documentation value="Text search in the description of the value set"/> </searchParam> <searchParam> <name value="name"/> <definition value="http://hl7.org/fhir/profiles/ValueSet"/> <type value="string"/> <documentation value="The name of the value set"/> </searchParam> <searchParam> <name value="_language"/> <definition value="http://hl7.org/fhir/profiles/ValueSet"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="code"/> <definition value="http://hl7.org/fhir/profiles/ValueSet"/> <type value="token"/> <documentation value="A code defined in the value set"/> </searchParam> <searchParam> <name value="date"/> <definition value="http://hl7.org/fhir/profiles/ValueSet"/> <type value="date"/> <documentation value="The value set publication date"/> </searchParam> <searchParam> <name value="identifier"/> <definition value="http://hl7.org/fhir/profiles/ValueSet"/> <type value="token"/> <documentation value="The identifier of the value set"/> </searchParam> <searchParam> <name value="reference"/> <definition value="http://hl7.org/fhir/profiles/ValueSet"/> <type value="token"/> <documentation value="A code system included or excluded in the value set or an imported value set"/> </searchParam> <searchParam> <name value="publisher"/> <definition value="http://hl7.org/fhir/profiles/ValueSet"/> <type value="string"/> <documentation value="Name of the publisher of the value set"/> </searchParam> <searchParam> <name value="version"/> <definition value="http://hl7.org/fhir/profiles/ValueSet"/> <type value="token"/> <documentation value="The version identifier of the value set"/> </searchParam> </resource> <operation> <code value="transaction"/> </operation> <operation> <code value="history-system"/> </operation> <operation> <code value="search-system"/> </operation> </rest> </Conformance> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><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> </summary> </entry> <entry> <title>"conformance-base2" - to help with system development</title> <id>http://hl7.org/fhir/conformance/conformance-base2</id> <link href="http://hl7.org/implement/standards/fhir/conformance/conformance-base2" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Conformance xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><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/></tr><tr><td>System History</td><td/></tr><tr><td>System Search</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/></tr></table></div> </text> <identifier value="http://hl7.org/fhir/conformance-base2"/> <version value="0.0.82.2943"/> <name value="Base FHIR Conformance Statement (Empty)"/> <publisher value="FHIR Project Team"/> <telecom> <system value="url"/> <value value="http://hl7.org/fhir"/> </telecom> <description value="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 value="draft"/> <date value="2014-09-30T18:08:29.499+10:00"/> <fhirVersion value="0.0.82"/> <acceptUnknown value="false"/> <format value="xml"/> <format value="json"/> <rest> <mode value="server"/> <documentation value="An empty conformance statement"/> <resource> <type value="Conformance"/> <operation> <code value="read"/> </operation> </resource> </rest> </Conformance> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><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/></tr><tr><td>System History</td><td/></tr><tr><td>System Search</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/></tr></table></div> </summary> </entry> <entry> <title>"adversereaction" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/adversereaction</id> <link href="http://hl7.org/implement/standards/fhir/adversereaction.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction" title="Records an unexpected reaction suspected to be related to the exposure of the reaction subject to a substance."><b>AdverseReaction</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.identifier" 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)."><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> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.date" title="The date (and possibly time) when the reaction began."><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> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.subject" title="The subject of the adverse reaction."><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> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.didNotOccurFlag" title="If true, indicates that no reaction occurred (this element modifies the meaning of other elements)"><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> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.recorder" title="Identifies the individual responsible for the information in the reaction record."><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> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.symptom" title="The signs and symptoms that were observed as part of the reaction."><b>symptom</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> What was reaction? --></span> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.symptom.code" title="Indicates the specific sign or symptom that was observed."><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 href="http://apps.who.int/classifications/icd10/browse/2010/en.html" style="color: navy">E.g. Rash, vomiting</a></span><span style="color: Gray"> --></span></code> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.symptom.severity" title="The severity of the sign or symptom."><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 href="reactionSeverity.html" style="color: navy">severe | serious | moderate | minor</a></span><span style="color: Gray"> --></span> </symptom> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.exposure" title="An exposure to a substance that preceded a reaction occurrence."><b>exposure</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Suspected substance --></span> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.exposure.date" title="Identifies the initial date of the exposure that is suspected to be related to the reaction."><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> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.exposure.type" title="The type of exposure: Drug Administration, Immunization, Coincidental."><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 href="exposureType.html" style="color: navy">drugadmin | immuniz | coincidental</a></span><span style="color: Gray"> --></span> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.exposure.causalityExpectation" title="A statement of how confident that the recorder was that this exposure caused the reaction."><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 href="causalityExpectation.html" style="color: navy">likely | unlikely | confirmed | unknown</a></span><span style="color: Gray"> --></span> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.exposure.substance" title="Substance that is presumed to have caused the adverse reaction."><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> </exposure> </AdverseReaction> </pre></div> </text> <name value="adversereaction"/> <publisher value="FHIR Project"/> <description value="Basic Profile. Records an unexpected reaction suspected to be related to the exposure of the reaction subject to a substance."/> <status value="draft"/> <date value="2014-09-30"/> <requirements value="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 value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <structure> <type value="AdverseReaction"/> <publish value="true"/> <element> <path value="AdverseReaction"/> <definition> <short value="Specific reactions to a substance"/> <formal value="Records an unexpected reaction suspected to be related to the exposure of the reaction subject to a substance."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Observation[classCode=OBS, moodCode=EVN]"/> </mapping> <mapping> <identity value="v2"/> <map value="IAM-11-Onset Date (Does not allow for IAM-12-Onset Date Text)"/> </mapping> </definition> </element> <element> <path value="AdverseReaction.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="AdverseReaction.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="AdverseReaction.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="AdverseReaction.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="AdverseReaction.identifier"/> <definition> <short value="External Ids for this adverse reaction"/> <formal value="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 value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> </definition> </element> <element> <path value="AdverseReaction.date"/> <definition> <short value="When the reaction occurred"/> <formal value="The date (and possibly time) when the reaction began."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="effectiveTime"/> </mapping> </definition> </element> <element> <path value="AdverseReaction.subject"/> <definition> <short value="Who had the reaction"/> <formal value="The subject of the adverse reaction."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="participation[typeCode=SBJ]"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-3-Patient ID List"/> </mapping> </definition> </element> <element> <path value="AdverseReaction.didNotOccurFlag"/> <definition> <short value="Indicates lack of reaction"/> <formal value="If true, indicates that no reaction occurred."/> <comments value="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 value="1"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="actionNegationInd"/> </mapping> </definition> </element> <element> <path value="AdverseReaction.recorder"/> <definition> <short value="Who recorded the reaction"/> <formal value="Identifies the individual responsible for the information in the reaction record."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="participation[typeCode=AUT]"/> </mapping> <mapping> <identity value="v2"/> <map value="IAM-14-Reported By (if patient) / IAM-18-Statused By Person (if practitioner)"/> </mapping> </definition> </element> <element> <path value="AdverseReaction.symptom"/> <definition> <short value="What was reaction?"/> <formal value="The signs and symptoms that were observed as part of the reaction."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=<<symptom>>]"/> </mapping> </definition> </element> <element> <path value="AdverseReaction.symptom.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="AdverseReaction.symptom.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="AdverseReaction.symptom.code"/> <definition> <short value="E.g. Rash, vomiting"/> <formal value="Indicates the specific sign or symptom that was observed."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="SymptomType"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceUri value="http://apps.who.int/classifications/icd10/browse/2010/en"/> </binding> <mapping> <identity value="rim"/> <map value="value"/> </mapping> <mapping> <identity value="v2"/> <map value="IAR-1"/> </mapping> </definition> </element> <element> <path value="AdverseReaction.symptom.severity"/> <definition> <short value="severe | serious | moderate | minor"/> <formal value="The severity of the sign or symptom."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="ReactionSeverity"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/reactionSeverity"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=<<severity>> ].value"/> </mapping> <mapping> <identity value="v2"/> <map value="AL1-4-Allergy Severity Code / IAM-4-Allergy Severity Code"/> </mapping> </definition> </element> <element> <path value="AdverseReaction.exposure"/> <definition> <short value="Suspected substance"/> <formal value="An exposure to a substance that preceded a reaction occurrence."/> <comments value="Multiple repetitions are used to indicate multiple potential causes for the reaction."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="outboundRelationship[typeCode=SAS].target[classCode=EXPOS, moodCode=EVN]"/> </mapping> </definition> </element> <element> <path value="AdverseReaction.exposure.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="AdverseReaction.exposure.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="AdverseReaction.exposure.date"/> <definition> <short value="When the exposure occurred"/> <formal value="Identifies the initial date of the exposure that is suspected to be related to the reaction."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="effectiveTime"/> </mapping> <mapping> <identity value="v2"/> <map value="(V2 does not define distinct concepts of exposure date and reaction date)"/> </mapping> </definition> </element> <element> <path value="AdverseReaction.exposure.type"/> <definition> <short value="drugadmin | immuniz | coincidental"/> <formal value="The type of exposure: Drug Administration, Immunization, Coincidental."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="ExposureType"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/exposureType"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="code"/> </mapping> </definition> </element> <element> <path value="AdverseReaction.exposure.causalityExpectation"/> <definition> <short value="likely | unlikely | confirmed | unknown"/> <formal value="A statement of how confident that the recorder was that this exposure caused the reaction."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="CausalityExpectation"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/causalityExpectation"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=<<ReactionRelatedn ess>, ].value Note: Observation also needs to have a subject of the Adverse Reaction itself (i.e. it's expressing relatedness of exposure & reaction)"/> </mapping> <mapping> <identity value="v2"/> <map value="IAM-17-Allergy Clinical Status Code"/> </mapping> </definition> </element> <element> <path value="AdverseReaction.exposure.substance"/> <definition> <short value="Presumed causative substance"/> <formal value="Substance that is presumed to have caused the adverse reaction."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Substance"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="participation[typeCode=EXPAGNT]"/> </mapping> <mapping> <identity value="v2"/> <map value="AL1-3 / IAM-3 Allergen Code/Mnemonic/Description"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="date"/> <type value="date"/> <documentation value="The date of the reaction"/> <xpath value="f:AdverseReaction/f:date"/> </searchParam> <searchParam> <name value="subject"/> <type value="reference"/> <documentation value="The subject that the sensitivity is about"/> <xpath value="f:AdverseReaction/f:subject"/> </searchParam> <searchParam> <name value="substance"/> <type value="reference"/> <documentation value="The name or code of the substance that produces the sensitivity"/> <xpath value="f:AdverseReaction/f:exposure/f:substance"/> </searchParam> <searchParam> <name value="symptom"/> <type value="token"/> <documentation value="One of the symptoms of the reaction"/> <xpath value="f:AdverseReaction/f:symptom/f:code"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction" title="Records an unexpected reaction suspected to be related to the exposure of the reaction subject to a substance."><b>AdverseReaction</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.identifier" 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)."><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> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.date" title="The date (and possibly time) when the reaction began."><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> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.subject" title="The subject of the adverse reaction."><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> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.didNotOccurFlag" title="If true, indicates that no reaction occurred (this element modifies the meaning of other elements)"><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> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.recorder" title="Identifies the individual responsible for the information in the reaction record."><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> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.symptom" title="The signs and symptoms that were observed as part of the reaction."><b>symptom</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> What was reaction? --></span> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.symptom.code" title="Indicates the specific sign or symptom that was observed."><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 href="http://apps.who.int/classifications/icd10/browse/2010/en.html" style="color: navy">E.g. Rash, vomiting</a></span><span style="color: Gray"> --></span></code> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.symptom.severity" title="The severity of the sign or symptom."><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 href="reactionSeverity.html" style="color: navy">severe | serious | moderate | minor</a></span><span style="color: Gray"> --></span> </symptom> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.exposure" title="An exposure to a substance that preceded a reaction occurrence."><b>exposure</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Suspected substance --></span> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.exposure.date" title="Identifies the initial date of the exposure that is suspected to be related to the reaction."><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> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.exposure.type" title="The type of exposure: Drug Administration, Immunization, Coincidental."><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 href="exposureType.html" style="color: navy">drugadmin | immuniz | coincidental</a></span><span style="color: Gray"> --></span> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.exposure.causalityExpectation" title="A statement of how confident that the recorder was that this exposure caused the reaction."><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 href="causalityExpectation.html" style="color: navy">likely | unlikely | confirmed | unknown</a></span><span style="color: Gray"> --></span> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.exposure.substance" title="Substance that is presumed to have caused the adverse reaction."><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> </exposure> </AdverseReaction> </pre></div> </summary> </entry> <entry> <title>"alert" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/alert</id> <link href="http://hl7.org/implement/standards/fhir/alert.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="alert-definitions.html#Alert" title="Prospective warnings of potential issues when providing care to the patient."><b>Alert</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="alert-definitions.html#Alert.identifier" title="Identifier assigned to the alert for external use (outside the FHIR environment)."><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> <<a class="dict" href="alert-definitions.html#Alert.category" title="Allows an alert to be divided into different categories like clinical, administrative etc."><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> <<a class="dict" href="alert-definitions.html#Alert.status" title="Supports basic workflow."><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 href="alert-status.html" style="color: navy">active | inactive | entered in error</a></span><span style="color: Gray"> --></span> <<a class="dict" href="alert-definitions.html#Alert.subject" title="The person who this alert concerns."><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> <<a class="dict" href="alert-definitions.html#Alert.author" title="The person or device that created the alert."><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> <<a class="dict" href="alert-definitions.html#Alert.note" title="The textual component of the alert to display to the user."><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> </Alert> </pre></div> </text> <name value="alert"/> <publisher value="FHIR Project"/> <description value="Basic Profile. Prospective warnings of potential issues when providing care to the patient."/> <status value="draft"/> <date value="2014-09-30"/> <requirements value="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.) Usually, 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 value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <structure> <type value="Alert"/> <publish value="true"/> <element> <path value="Alert"/> <definition> <short value="Key information to flag to healthcare providers"/> <formal value="Prospective warnings of potential issues when providing care to the patient."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Observation[classCode=ISSUE, moodCode=EVN]"/> </mapping> </definition> </element> <element> <path value="Alert.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Alert.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Alert.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Alert.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Alert.identifier"/> <definition> <short value="Business identifier"/> <formal value="Identifier assigned to the alert for external use (outside the FHIR environment)."/> <min value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> </definition> </element> <element> <path value="Alert.category"/> <definition> <short value="Clinical, administrative, etc."/> <formal value="Allows an alert to be divided into different categories like clinical, administrative etc."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> </definition> </element> <element> <path value="Alert.status"/> <definition> <short value="active | inactive | entered in error"/> <formal value="Supports basic workflow."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="AlertStatus"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/alert-status"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".status"/> </mapping> </definition> </element> <element> <path value="Alert.subject"/> <definition> <short value="Who is alert about?"/> <formal value="The person who this alert concerns."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=SBJ].role[classCode=PAT]"/> </mapping> </definition> </element> <element> <path value="Alert.author"/> <definition> <short value="Alert creator"/> <formal value="The person or device that created the alert."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Device"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=AUT].role"/> </mapping> </definition> </element> <element> <path value="Alert.note"/> <definition> <short value="Text of alert"/> <formal value="The textual component of the alert to display to the user."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".value"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="subject"/> <type value="reference"/> <documentation value="The identity of a subject to list alerts for"/> <xpath value="f:Alert/f:subject"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="alert-definitions.html#Alert" title="Prospective warnings of potential issues when providing care to the patient."><b>Alert</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="alert-definitions.html#Alert.identifier" title="Identifier assigned to the alert for external use (outside the FHIR environment)."><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> <<a class="dict" href="alert-definitions.html#Alert.category" title="Allows an alert to be divided into different categories like clinical, administrative etc."><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> <<a class="dict" href="alert-definitions.html#Alert.status" title="Supports basic workflow."><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 href="alert-status.html" style="color: navy">active | inactive | entered in error</a></span><span style="color: Gray"> --></span> <<a class="dict" href="alert-definitions.html#Alert.subject" title="The person who this alert concerns."><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> <<a class="dict" href="alert-definitions.html#Alert.author" title="The person or device that created the alert."><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> <<a class="dict" href="alert-definitions.html#Alert.note" title="The textual component of the alert to display to the user."><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> </Alert> </pre></div> </summary> </entry> <entry> <title>"allergyintolerance" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/allergyintolerance</id> <link href="http://hl7.org/implement/standards/fhir/allergyintolerance.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="allergyintolerance-definitions.html#AllergyIntolerance" title="Indicates the patient has a susceptibility to an adverse reaction upon exposure to a specified substance."><b>AllergyIntolerance</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="allergyintolerance-definitions.html#AllergyIntolerance.identifier" 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)."><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> <<a class="dict" href="allergyintolerance-definitions.html#AllergyIntolerance.criticality" title="Criticality of the sensitivity."><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 href="criticality.html" style="color: navy">fatal | high | medium | low</a></span><span style="color: Gray"> --></span> <<a class="dict" href="allergyintolerance-definitions.html#AllergyIntolerance.sensitivityType" title="Type of the sensitivity."><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 href="sensitivitytype.html" style="color: navy">allergy | intolerance | unknown</a></span><span style="color: Gray"> --></span> <<a class="dict" href="allergyintolerance-definitions.html#AllergyIntolerance.recordedDate" title="Date when the sensitivity was recorded."><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> <<a class="dict" href="allergyintolerance-definitions.html#AllergyIntolerance.status" title="Status of the sensitivity (this element modifies the meaning of other elements)"><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 href="sensitivitystatus.html" style="color: navy">suspected | confirmed | refuted | resolved</a></span><span style="color: Gray"> --></span> <<a class="dict" href="allergyintolerance-definitions.html#AllergyIntolerance.subject" title="The patient who has the allergy or intolerance."><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> <<a class="dict" href="allergyintolerance-definitions.html#AllergyIntolerance.recorder" title="Indicates who has responsibility for the record."><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> <<a class="dict" href="allergyintolerance-definitions.html#AllergyIntolerance.substance" title="The substance that causes the sensitivity."><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> <<a class="dict" href="allergyintolerance-definitions.html#AllergyIntolerance.reaction" title="Reactions associated with the sensitivity."><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> <<a class="dict" href="allergyintolerance-definitions.html#AllergyIntolerance.sensitivityTest" title="Observations that confirm or refute the sensitivity."><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"> Observations that confirm or refute</span><span style="color: Gray"> --></span></sensitivityTest> </AllergyIntolerance> </pre></div> </text> <name value="allergyintolerance"/> <publisher value="FHIR Project"/> <description value="Basic Profile. Indicates the patient has a susceptibility to an adverse reaction upon exposure to a specified substance."/> <status value="draft"/> <date value="2014-09-30"/> <requirements value="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: A 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. This 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. Note 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 value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <structure> <type value="AllergyIntolerance"/> <publish value="true"/> <element> <path value="AllergyIntolerance"/> <definition> <short value="Drug, food, environmental and others"/> <formal value="Indicates the patient has a susceptibility to an adverse reaction upon exposure to a specified substance."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Observation[moodCode=EVN, code<AllergyIntolerance]"/> </mapping> </definition> </element> <element> <path value="AllergyIntolerance.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="AllergyIntolerance.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="AllergyIntolerance.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="AllergyIntolerance.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="AllergyIntolerance.identifier"/> <definition> <short value="External Ids for this item"/> <formal value="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 value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> </definition> </element> <element> <path value="AllergyIntolerance.criticality"/> <definition> <short value="fatal | high | medium | low"/> <formal value="Criticality of the sensitivity."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="Criticality"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/criticality"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="criticality" ].value"/> </mapping> </definition> </element> <element> <path value="AllergyIntolerance.sensitivityType"/> <definition> <short value="allergy | intolerance | unknown"/> <formal value="Type of the sensitivity."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="SensitivityType"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/sensitivitytype"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="sensitivity" ].value"/> </mapping> <mapping> <identity value="v2"/> <map value="IAM-9-Sensitivity to Causative Agent Code"/> </mapping> </definition> </element> <element> <path value="AllergyIntolerance.recordedDate"/> <definition> <short value="When recorded"/> <formal value="Date when the sensitivity was recorded."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=AUT].time"/> </mapping> <mapping> <identity value="v2"/> <map value="IAM-20-Statused at Date/Time"/> </mapping> </definition> </element> <element> <path value="AllergyIntolerance.status"/> <definition> <short value="suspected | confirmed | refuted | resolved"/> <formal value="Status of the sensitivity."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="SensitivityStatus"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/sensitivitystatus"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".status (suspected/confirmed differentiated by uncertaintyCode)"/> </mapping> <mapping> <identity value="v2"/> <map value="IAM-17-Allergy Clinical Status Code"/> </mapping> </definition> </element> <element> <path value="AllergyIntolerance.subject"/> <definition> <short value="Who the sensitivity is for"/> <formal value="The patient who has the allergy or intolerance."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=SBJ].role[classCode=PAT]"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-3-Patient ID List"/> </mapping> </definition> </element> <element> <path value="AllergyIntolerance.recorder"/> <definition> <short value="Who recorded the sensitivity"/> <formal value="Indicates who has responsibility for the record."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=AUT].role"/> </mapping> <mapping> <identity value="v2"/> <map value="IAM-14-Reported By (if patient) / IAM-18-Statused By Person (if practitioner)"/> </mapping> </definition> </element> <element> <path value="AllergyIntolerance.substance"/> <definition> <short value="The substance that causes the sensitivity"/> <formal value="The substance that causes the sensitivity."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Substance"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=SBJ].role[classCode=ADMM]"/> </mapping> <mapping> <identity value="v2"/> <map value="AL1-3-Allergen Code/Mnemonic/Description / IAM-3-Allergen Code/Mnemonic/Description"/> </mapping> </definition> </element> <element> <path value="AllergyIntolerance.reaction"/> <definition> <short value="Reactions associated with the sensitivity"/> <formal value="Reactions associated with the sensitivity."/> <min value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/AdverseReaction"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=SPRT].target[classCode=OBS, moodCode=EVN, code<AdverseReaction]"/> </mapping> <mapping> <identity value="v2"/> <map value="IAM-7-Allergy Unique Identifier (Overloaded concept)"/> </mapping> </definition> </element> <element> <path value="AllergyIntolerance.sensitivityTest"/> <definition> <short value="Observations that confirm or refute"/> <formal value="Observations that confirm or refute the sensitivity."/> <min value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Observation"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=SPRT].target[classCode=OBS, moodCode=EVN, code<SensitivityTest]"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-21-Observation Instance Identifier (Subject to Ch7 caveats)"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="date"/> <type value="date"/> <documentation value="Recorded date/time."/> <xpath value="f:AllergyIntolerance/f:recordedDate"/> </searchParam> <searchParam> <name value="recorder"/> <type value="reference"/> <documentation value="Who recorded the sensitivity"/> <xpath value="f:AllergyIntolerance/f:recorder"/> </searchParam> <searchParam> <name value="status"/> <type value="token"/> <documentation value="The status of the sensitivity"/> <xpath value="f:AllergyIntolerance/f:status"/> </searchParam> <searchParam> <name value="subject"/> <type value="reference"/> <documentation value="The subject that the sensitivity is about"/> <xpath value="f:AllergyIntolerance/f:subject"/> </searchParam> <searchParam> <name value="substance"/> <type value="reference"/> <documentation value="The name or code of the substance that produces the sensitivity"/> <xpath value="f:AllergyIntolerance/f:substance"/> </searchParam> <searchParam> <name value="type"/> <type value="token"/> <documentation value="The type of sensitivity"/> <xpath value="f:AllergyIntolerance/f:sensitivityType"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="allergyintolerance-definitions.html#AllergyIntolerance" title="Indicates the patient has a susceptibility to an adverse reaction upon exposure to a specified substance."><b>AllergyIntolerance</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="allergyintolerance-definitions.html#AllergyIntolerance.identifier" 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)."><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> <<a class="dict" href="allergyintolerance-definitions.html#AllergyIntolerance.criticality" title="Criticality of the sensitivity."><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 href="criticality.html" style="color: navy">fatal | high | medium | low</a></span><span style="color: Gray"> --></span> <<a class="dict" href="allergyintolerance-definitions.html#AllergyIntolerance.sensitivityType" title="Type of the sensitivity."><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 href="sensitivitytype.html" style="color: navy">allergy | intolerance | unknown</a></span><span style="color: Gray"> --></span> <<a class="dict" href="allergyintolerance-definitions.html#AllergyIntolerance.recordedDate" title="Date when the sensitivity was recorded."><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> <<a class="dict" href="allergyintolerance-definitions.html#AllergyIntolerance.status" title="Status of the sensitivity (this element modifies the meaning of other elements)"><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 href="sensitivitystatus.html" style="color: navy">suspected | confirmed | refuted | resolved</a></span><span style="color: Gray"> --></span> <<a class="dict" href="allergyintolerance-definitions.html#AllergyIntolerance.subject" title="The patient who has the allergy or intolerance."><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> <<a class="dict" href="allergyintolerance-definitions.html#AllergyIntolerance.recorder" title="Indicates who has responsibility for the record."><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> <<a class="dict" href="allergyintolerance-definitions.html#AllergyIntolerance.substance" title="The substance that causes the sensitivity."><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> <<a class="dict" href="allergyintolerance-definitions.html#AllergyIntolerance.reaction" title="Reactions associated with the sensitivity."><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> <<a class="dict" href="allergyintolerance-definitions.html#AllergyIntolerance.sensitivityTest" title="Observations that confirm or refute the sensitivity."><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"> Observations that confirm or refute</span><span style="color: Gray"> --></span></sensitivityTest> </AllergyIntolerance> </pre></div> </summary> </entry> <entry> <title>"careplan" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/careplan</id> <link href="http://hl7.org/implement/standards/fhir/careplan.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="careplan-definitions.html#CarePlan" 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."><b>CarePlan</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="careplan-definitions.html#CarePlan.identifier" 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)."><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> <<a class="dict" href="careplan-definitions.html#CarePlan.patient" title="Identifies the patient/subject whose intended care is described by the plan."><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> <<a class="dict" href="careplan-definitions.html#CarePlan.status" 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)"><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 href="care-plan-status.html" style="color: navy">planned | active | completed</a></span><span style="color: Gray"> --></span> <<a class="dict" href="careplan-definitions.html#CarePlan.period" title="Indicates when the plan did (or is intended to) come into effect and end."><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> <<a class="dict" href="careplan-definitions.html#CarePlan.modified" title="Identifies the most recent date on which the plan has been revised."><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> <<a class="dict" href="careplan-definitions.html#CarePlan.concern" title="Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan."><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> <<a class="dict" href="careplan-definitions.html#CarePlan.participant" title="Identifies all people and organizations who are expected to be involved in the care envisioned by this plan."><b>participant</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Who's involved in plan? --></span> <<a class="dict" href="careplan-definitions.html#CarePlan.participant.role" title="Indicates specific responsibility of an individual within the care plan. E.g. "Primary physician", "Team coordinator", "Caregiver", etc."><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> <<a class="dict" href="careplan-definitions.html#CarePlan.participant.member" title="The specific person or organization who is participating/expected to participate in the care plan."><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> </participant> <<a class="dict" href="careplan-definitions.html#CarePlan.goal" title="Describes the intended objective(s) of carrying out the Care Plan."><b>goal</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Desired outcome of plan --></span> <<a class="dict" href="careplan-definitions.html#CarePlan.goal.description" title="Human-readable description of a specific desired objective of the care plan."><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> <<a class="dict" href="careplan-definitions.html#CarePlan.goal.status" title="Indicates whether the goal has been reached and is still considered relevant."><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 href="care-plan-goal-status.html" style="color: navy">in progress | achieved | sustaining | cancelled</a></span><span style="color: Gray"> --></span> <<a class="dict" href="careplan-definitions.html#CarePlan.goal.notes" title="Any comments related to the goal."><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> <<a class="dict" href="careplan-definitions.html#CarePlan.goal.concern" title="The identified conditions that this goal relates to - the condition that caused it to be created, or that it is intended to address."><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> </goal> <<a class="dict" href="careplan-definitions.html#CarePlan.activity" 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."><b>activity</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Action to occur as part of plan --></span> <<a class="dict" href="careplan-definitions.html#CarePlan.activity.goal" title="Internal reference that identifies the goals that this activity is intended to contribute towards meeting."><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> <<a class="dict" href="careplan-definitions.html#CarePlan.activity.status" title="Identifies what progress is being made for the specific activity."><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 href="care-plan-activity-status.html" style="color: navy">not started | scheduled | in progress | on hold | completed | cancelled</a></span><span style="color: Gray"> --></span> <<a class="dict" href="careplan-definitions.html#CarePlan.activity.prohibited" 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)"><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> <<a class="dict" href="careplan-definitions.html#CarePlan.activity.actionResulting" title="Resources that describe follow-on actions resulting from the plan, such as drug prescriptions, encounter records, appointments, etc."><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> <<a class="dict" href="careplan-definitions.html#CarePlan.activity.notes" title="Notes about the execution of the activity."><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> <<a class="dict" href="careplan-definitions.html#CarePlan.activity.detail" title="The details of the proposed activity represented in a specific resource."><b>detail</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-3: Only provide a detail reference, or a simple detail summary"><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>| <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> <<a class="dict" href="careplan-definitions.html#CarePlan.activity.simple" 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."><b>simple</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-3: Only provide a detail reference, or a simple detail summary"><b><img alt="??" src="lock.png"/> 0..1</b></span> Activity details summarised here --></span> <<a class="dict" href="careplan-definitions.html#CarePlan.activity.simple.category" title="High-level categorization of the type of activity in a care plan."><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 href="care-plan-activity-category.html" style="color: navy">diet | drug | encounter | observation | procedure | supply | other</a></span><span style="color: Gray"> --></span> <<a class="dict" href="careplan-definitions.html#CarePlan.activity.simple.code" title="Detailed description of the type of activity. E.g. What lab test, what procedure, what kind of encounter."><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> <<a class="dict" href="careplan-definitions.html#CarePlan.activity.simple.timing_x_" title="The period, timing or frequency upon which the described activity is to occur."><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]> <<a class="dict" href="careplan-definitions.html#CarePlan.activity.simple.location" title="Identifies the facility where the activity will occur. E.g. home, hospital, specific clinic, etc."><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> <<a class="dict" href="careplan-definitions.html#CarePlan.activity.simple.performer" title="Identifies who's expected to be involved in the activity."><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"> Who's responsible?</span><span style="color: Gray"> --></span></performer> <<a class="dict" href="careplan-definitions.html#CarePlan.activity.simple.product" title="Identifies the food, drug or other product being consumed or supplied in the activity."><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> <<a class="dict" href="careplan-definitions.html#CarePlan.activity.simple.dailyAmount" title="Identifies the quantity expected to be consumed in a given day."><b>dailyAmount</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: DailyDose can only be specified if activity category is drug or food"><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> <<a class="dict" href="careplan-definitions.html#CarePlan.activity.simple.quantity" title="Identifies the quantity expected to be supplied."><b>quantity</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-2: Quantity can only be specified if activity category is supply"><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> <<a class="dict" href="careplan-definitions.html#CarePlan.activity.simple.details" 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."><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> </simple> </activity> <<a class="dict" href="careplan-definitions.html#CarePlan.notes" title="General notes about the care plan not covered elsewhere."><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> </CarePlan> </pre></div> </text> <name value="careplan"/> <publisher value="FHIR Project"/> <description value="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 value="draft"/> <date value="2014-09-30"/> <requirements value="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. This 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. Comments 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 value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <structure> <type value="CarePlan"/> <publish value="true"/> <element> <path value="CarePlan"/> <definition> <short value="Healthcare plan for patient"/> <formal value="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 value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Act[classCode=PCPR, moodCode=INT]"/> </mapping> </definition> </element> <element> <path value="CarePlan.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="CarePlan.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="CarePlan.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="CarePlan.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="CarePlan.identifier"/> <definition> <short value="External Ids for this plan"/> <formal value="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 value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> </definition> </element> <element> <path value="CarePlan.patient"/> <definition> <short value="Who care plan is for"/> <formal value="Identifies the patient/subject whose intended care is described by the plan."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=PAT].role[classCode=PAT]"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-3-patient ID list"/> </mapping> </definition> </element> <element> <path value="CarePlan.status"/> <definition> <short value="planned | active | completed"/> <formal value="Indicates whether the plan is currently being acted upon, represents future intentions or is now just historical record."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="CarePlanStatus"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/care-plan-status"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".statusCode planned = new active = active completed = completed"/> </mapping> <mapping> <identity value="v2"/> <map value="PTH-5-pathway life cycle status"/> </mapping> </definition> </element> <element> <path value="CarePlan.period"/> <definition> <short value="Time period plan covers"/> <formal value="Indicates when the plan did (or is intended to) come into effect and end."/> <comments value="Any activities scheduled as part of the plan should be constrained to the specified period."/> <min value="0"/> <max value="1"/> <type> <code value="Period"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".effectiveTime"/> </mapping> <mapping> <identity value="v2"/> <map value="GOL-7-goal established date/time / GOL-8-expected goal achieve date/time"/> </mapping> </definition> </element> <element> <path value="CarePlan.modified"/> <definition> <short value="When last updated"/> <formal value="Identifies the most recent date on which the plan has been revised."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=AUT].time"/> </mapping> <mapping> <identity value="v2"/> <map value="PTH-6-change pathway life cycle status date/time"/> </mapping> </definition> </element> <element> <path value="CarePlan.concern"/> <definition> <short value="Health issues this plan addresses"/> <formal value="Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan."/> <min value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Condition"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".actRelationship[typeCode=SUBJ].target[classCode=CONC, moodCode=EVN]"/> </mapping> <mapping> <identity value="v2"/> <map value="PRB-4-Problem instance ID"/> </mapping> </definition> </element> <element> <path value="CarePlan.participant"/> <definition> <short value="Who's involved in plan?"/> <formal value="Identifies all people and organizations who are expected to be involved in the care envisioned by this plan."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=PFM]"/> </mapping> <mapping> <identity value="v2"/> <map value="REL (REL.4 is always the Patient) ( or PRT?)"/> </mapping> </definition> </element> <element> <path value="CarePlan.participant.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="CarePlan.participant.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="CarePlan.participant.role"/> <definition> <short value="Type of involvement"/> <formal value="Indicates specific responsibility of an individual within the care plan. E.g. "Primary physician", "Team coordinator", "Caregiver", etc."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="CarePlanParticipantRole"/> <isExtensible value="true"/> <conformance value="preferred"/> <description value="Indicates specific responsibility of an individual within the care plan. E.g. "Primary physician", "Team coordinator", "Caregiver", etc."/> </binding> <mapping> <identity value="rim"/> <map value=".functionCode"/> </mapping> <mapping> <identity value="v2"/> <map value="REL.2 (or PRT-4-participation?)"/> </mapping> </definition> </element> <element> <path value="CarePlan.participant.member"/> <definition> <short value="Who is involved"/> <formal value="The specific person or organization who is participating/expected to participate in the care plan."/> <comments value="Patient only needs to be listed if they have a role other than "subject of care"."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/RelatedPerson"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Organization"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".role"/> </mapping> <mapping> <identity value="v2"/> <map value="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?)"/> </mapping> </definition> </element> <element> <path value="CarePlan.goal"/> <definition> <short value="Desired outcome of plan"/> <formal value="Describes the intended objective(s) of carrying out the Care Plan."/> <comments value="Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode<=OBJ]."/> </mapping> <mapping> <identity value="v2"/> <map value="GOL.1"/> </mapping> </definition> </element> <element> <path value="CarePlan.goal.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="CarePlan.goal.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="CarePlan.goal.description"/> <definition> <short value="What's the desired outcome?"/> <formal value="Human-readable description of a specific desired objective of the care plan."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".text"/> </mapping> <mapping> <identity value="v2"/> <map value="GOL-3.2-goal ID.text"/> </mapping> </definition> </element> <element> <path value="CarePlan.goal.status"/> <definition> <short value="in progress | achieved | sustaining | cancelled"/> <formal value="Indicates whether the goal has been reached and is still considered relevant."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="CarePlanGoalStatus"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/care-plan-goal-status"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".statusCode in progress = active (classCode = OBJ) achieved = complete sustaining = active (classCode=OBJC) cancelled = aborted"/> </mapping> <mapping> <identity value="v2"/> <map value="GOL-18-goal life cycle status"/> </mapping> </definition> </element> <element> <path value="CarePlan.goal.notes"/> <definition> <short value="Comments about the goal"/> <formal value="Any comments related to the goal."/> <comments value="May be used for progress notes, concerns or other related information that doesn't actually describe the goal itself."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="annotation"] .value"/> </mapping> <mapping> <identity value="v2"/> <map value="GOL-16-goal evaluation + NTE?"/> </mapping> </definition> </element> <element> <path value="CarePlan.goal.concern"/> <definition> <short value="Health issues this goal addresses"/> <formal value="The identified conditions that this goal relates to - the condition that caused it to be created, or that it is intended to address."/> <comments value="The concerns do not also need to be listed under CarePlan.concern, but may be."/> <min value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Condition"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=SUBJ].target[classCode=CONC]"/> </mapping> </definition> </element> <element> <path value="CarePlan.activity"/> <definition> <short value="Action to occur as part of plan"/> <formal value="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 value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=COMP].target"/> </mapping> </definition> </element> <element> <path value="CarePlan.activity.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="CarePlan.activity.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="CarePlan.activity.goal"/> <definition> <short value="Goals this activity relates to"/> <formal value="Internal reference that identifies the goals that this activity is intended to contribute towards meeting."/> <min value="0"/> <max value="*"/> <type> <code value="idref"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode<=OBJ]."/> </mapping> </definition> </element> <element> <path value="CarePlan.activity.status"/> <definition> <short value="not started | scheduled | in progress | on hold | completed | cancelled"/> <formal value="Identifies what progress is being made for the specific activity."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="CarePlanActivityStatus"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/care-plan-activity-status"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".statusCode not started = new scheduled = not started (and fulfillment relationship to appointent) in progress = active on hold = suspended completed = completed cancelled = aborted"/> </mapping> <mapping> <identity value="v2"/> <map value="ORC-5-order status?"/> </mapping> </definition> </element> <element> <path value="CarePlan.activity.prohibited"/> <definition> <short value="Do NOT do"/> <formal value="If true, indicates that the described activity is one that must NOT be engaged in when following the plan."/> <min value="1"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="actionNegationInd"/> </mapping> </definition> </element> <element> <path value="CarePlan.activity.actionResulting"/> <definition> <short value="Appointments, orders, etc."/> <formal value="Resources that describe follow-on actions resulting from the plan, such as drug prescriptions, encounter records, appointments, etc."/> <min value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Any"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=FLFS].source"/> </mapping> </definition> </element> <element> <path value="CarePlan.activity.notes"/> <definition> <short value="Comments about the activity"/> <formal value="Notes about the execution of the activity."/> <comments value="Doesn't describe the activity - that goes in details."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="annotation"] .value"/> </mapping> <mapping> <identity value="v2"/> <map value="NTE?"/> </mapping> </definition> </element> <element> <path value="CarePlan.activity.detail"/> <definition> <short value="Activity details defined in specific resource"/> <formal value="The details of the proposed activity represented in a specific resource."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Procedure"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/MedicationPrescription"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Encounter"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=COMP].target"/> </mapping> </definition> </element> <element> <path value="CarePlan.activity.simple"/> <definition> <short value="Activity details summarised here"/> <formal value="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 value="0"/> <max value="1"/> <constraint> <key value="3"/> <name value="details by reference, or simple details"/> <severity value="error"/> <human value="Only provide a detail reference, or a simple detail summary"/> <xpath value="not(exists(f:detail)) or not(exists(f:simple))"/> </constraint> <constraint> <key value="2"/> <name value="quantity for supply"/> <severity value="error"/> <human value="Quantity can only be specified if activity category is supply"/> <xpath value="(f:category/@value=('supply')) = exists(f:quantity)"/> </constraint> <constraint> <key value="1"/> <name value="dose for food or drug"/> <severity value="error"/> <human value="DailyDose can only be specified if activity category is drug or food"/> <xpath value="(f:category/@value=('drug','diet')) = exists(f:dailyAmount)"/> </constraint> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target"/> </mapping> </definition> </element> <element> <path value="CarePlan.activity.simple.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="CarePlan.activity.simple.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="CarePlan.activity.simple.category"/> <definition> <short value="diet | drug | encounter | observation | procedure | supply | other"/> <formal value="High-level categorization of the type of activity in a care plan."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="CarePlanActivityCategory"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/care-plan-activity-category"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=COMP].source[classCode=LIST].code"/> </mapping> </definition> </element> <element> <path value="CarePlan.activity.simple.code"/> <definition> <short value="Detail type of activity"/> <formal value="Detailed description of the type of activity. E.g. What lab test, what procedure, what kind of encounter."/> <comments value="Tends to be less relevant for activities involving particular products. Codes should not convey negation - use "prohibited" instead."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="CarePlanActivityType"/> <isExtensible value="true"/> <conformance value="preferred"/> <description value="Detailed description of the type of activity. E.g. What lab test, what procedure, what kind of encounter."/> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> <mapping> <identity value="v2"/> <map value="OBR-4-universal service ID / RXE-2-Give Code / RXO-1-Requested Give Code / RXD-2-Dispense/Give Code"/> </mapping> </definition> </element> <element> <path value="CarePlan.activity.simple.timing[x]"/> <definition> <short value="When activity is to occur"/> <formal value="The period, timing or frequency upon which the described activity is to occur."/> <min value="0"/> <max value="1"/> <type> <code value="Schedule"/> </type> <type> <code value="Period"/> </type> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".effectiveTime"/> </mapping> <mapping> <identity value="v2"/> <map value="TQ1"/> </mapping> </definition> </element> <element> <path value="CarePlan.activity.simple.location"/> <definition> <short value="Where it should happen"/> <formal value="Identifies the facility where the activity will occur. E.g. home, hospital, specific clinic, etc."/> <comments value="May reference a specific clinical location or may just identify a type of location."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Location"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=LOC].role"/> </mapping> <mapping> <identity value="v2"/> <map value="OBR-24-diagnostic service section ID (???!!)"/> </mapping> </definition> </element> <element> <path value="CarePlan.activity.simple.performer"/> <definition> <short value="Who's responsible?"/> <formal value="Identifies who's expected to be involved in the activity."/> <comments value="A performer MAY also be a participant in the care plan."/> <min value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Organization"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/RelatedPerson"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=PFM]"/> </mapping> <mapping> <identity value="v2"/> <map value="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"/> </mapping> </definition> </element> <element> <path value="CarePlan.activity.simple.product"/> <definition> <short value="What's administered/supplied"/> <formal value="Identifies the food, drug or other product being consumed or supplied in the activity."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Medication"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Substance"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=PRD].role"/> </mapping> <mapping> <identity value="v2"/> <map value="RXE-2-Give Code / RXO-1-Requested Give Code / RXD-2-Dispense/Give Code"/> </mapping> </definition> </element> <element> <path value="CarePlan.activity.simple.dailyAmount"/> <definition> <short value="How much consumed/day?"/> <formal value="Identifies the quantity expected to be consumed in a given day."/> <min value="0"/> <max value="1"/> <type> <code value="Quantity"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=COMP][classCode=SBADM].doseQuantity"/> </mapping> <mapping> <identity value="v2"/> <map value="RXO-23-total daily dose / RXE-19-total daily dose / RXD-12-total daily dose"/> </mapping> </definition> </element> <element> <path value="CarePlan.activity.simple.quantity"/> <definition> <short value="How much is administered/supplied/consumed"/> <formal value="Identifies the quantity expected to be supplied."/> <min value="0"/> <max value="1"/> <type> <code value="Quantity"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=COMP][classCode=SPLY].quantity"/> </mapping> <mapping> <identity value="v2"/> <map value="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"/> </mapping> </definition> </element> <element> <path value="CarePlan.activity.simple.details"/> <definition> <short value="Extra info on activity occurrence"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".text"/> </mapping> <mapping> <identity value="v2"/> <map value="NTE?"/> </mapping> </definition> </element> <element> <path value="CarePlan.notes"/> <definition> <short value="Comments about the plan"/> <formal value="General notes about the care plan not covered elsewhere."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="annotation"] .value"/> </mapping> <mapping> <identity value="v2"/> <map value="NTE?"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="activitycode"/> <type value="token"/> <documentation value="Detail type of activity"/> <xpath value="f:CarePlan/f:activity/f:simple/f:code"/> </searchParam> <searchParam> <name value="activitydate"/> <type value="date"/> <documentation value="Specified date occurs within period specified by CarePlan.activity.timingSchedule"/> <xpath value="f:CarePlan/f:activity/f:simple/f:timing[x]"/> </searchParam> <searchParam> <name value="activitydetail"/> <type value="reference"/> <documentation value="Activity details defined in specific resource"/> <xpath value="f:CarePlan/f:activity/f:detail"/> </searchParam> <searchParam> <name value="condition"/> <type value="reference"/> <documentation value="Health issues this plan addresses"/> <xpath value="f:CarePlan/f:concern"/> </searchParam> <searchParam> <name value="date"/> <type value="date"/> <documentation value="Time period plan covers"/> <xpath value="f:CarePlan/f:period"/> </searchParam> <searchParam> <name value="participant"/> <type value="reference"/> <documentation value="Who is involved"/> <xpath value="f:CarePlan/f:participant/f:member"/> </searchParam> <searchParam> <name value="patient"/> <type value="reference"/> <documentation value="Who care plan is for"/> <xpath value="f:CarePlan/f:patient"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="careplan-definitions.html#CarePlan" 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."><b>CarePlan</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="careplan-definitions.html#CarePlan.identifier" 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)."><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> <<a class="dict" href="careplan-definitions.html#CarePlan.patient" title="Identifies the patient/subject whose intended care is described by the plan."><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> <<a class="dict" href="careplan-definitions.html#CarePlan.status" 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)"><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 href="care-plan-status.html" style="color: navy">planned | active | completed</a></span><span style="color: Gray"> --></span> <<a class="dict" href="careplan-definitions.html#CarePlan.period" title="Indicates when the plan did (or is intended to) come into effect and end."><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> <<a class="dict" href="careplan-definitions.html#CarePlan.modified" title="Identifies the most recent date on which the plan has been revised."><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> <<a class="dict" href="careplan-definitions.html#CarePlan.concern" title="Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan."><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> <<a class="dict" href="careplan-definitions.html#CarePlan.participant" title="Identifies all people and organizations who are expected to be involved in the care envisioned by this plan."><b>participant</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Who's involved in plan? --></span> <<a class="dict" href="careplan-definitions.html#CarePlan.participant.role" title="Indicates specific responsibility of an individual within the care plan. E.g. "Primary physician", "Team coordinator", "Caregiver", etc."><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> <<a class="dict" href="careplan-definitions.html#CarePlan.participant.member" title="The specific person or organization who is participating/expected to participate in the care plan."><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> </participant> <<a class="dict" href="careplan-definitions.html#CarePlan.goal" title="Describes the intended objective(s) of carrying out the Care Plan."><b>goal</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Desired outcome of plan --></span> <<a class="dict" href="careplan-definitions.html#CarePlan.goal.description" title="Human-readable description of a specific desired objective of the care plan."><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> <<a class="dict" href="careplan-definitions.html#CarePlan.goal.status" title="Indicates whether the goal has been reached and is still considered relevant."><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 href="care-plan-goal-status.html" style="color: navy">in progress | achieved | sustaining | cancelled</a></span><span style="color: Gray"> --></span> <<a class="dict" href="careplan-definitions.html#CarePlan.goal.notes" title="Any comments related to the goal."><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> <<a class="dict" href="careplan-definitions.html#CarePlan.goal.concern" title="The identified conditions that this goal relates to - the condition that caused it to be created, or that it is intended to address."><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> </goal> <<a class="dict" href="careplan-definitions.html#CarePlan.activity" 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."><b>activity</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Action to occur as part of plan --></span> <<a class="dict" href="careplan-definitions.html#CarePlan.activity.goal" title="Internal reference that identifies the goals that this activity is intended to contribute towards meeting."><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> <<a class="dict" href="careplan-definitions.html#CarePlan.activity.status" title="Identifies what progress is being made for the specific activity."><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 href="care-plan-activity-status.html" style="color: navy">not started | scheduled | in progress | on hold | completed | cancelled</a></span><span style="color: Gray"> --></span> <<a class="dict" href="careplan-definitions.html#CarePlan.activity.prohibited" 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)"><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> <<a class="dict" href="careplan-definitions.html#CarePlan.activity.actionResulting" title="Resources that describe follow-on actions resulting from the plan, such as drug prescriptions, encounter records, appointments, etc."><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> <<a class="dict" href="careplan-definitions.html#CarePlan.activity.notes" title="Notes about the execution of the activity."><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> <<a class="dict" href="careplan-definitions.html#CarePlan.activity.detail" title="The details of the proposed activity represented in a specific resource."><b>detail</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-3: Only provide a detail reference, or a simple detail summary"><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>| <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> <<a class="dict" href="careplan-definitions.html#CarePlan.activity.simple" 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."><b>simple</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-3: Only provide a detail reference, or a simple detail summary"><b><img alt="??" src="lock.png"/> 0..1</b></span> Activity details summarised here --></span> <<a class="dict" href="careplan-definitions.html#CarePlan.activity.simple.category" title="High-level categorization of the type of activity in a care plan."><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 href="care-plan-activity-category.html" style="color: navy">diet | drug | encounter | observation | procedure | supply | other</a></span><span style="color: Gray"> --></span> <<a class="dict" href="careplan-definitions.html#CarePlan.activity.simple.code" title="Detailed description of the type of activity. E.g. What lab test, what procedure, what kind of encounter."><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> <<a class="dict" href="careplan-definitions.html#CarePlan.activity.simple.timing_x_" title="The period, timing or frequency upon which the described activity is to occur."><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]> <<a class="dict" href="careplan-definitions.html#CarePlan.activity.simple.location" title="Identifies the facility where the activity will occur. E.g. home, hospital, specific clinic, etc."><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> <<a class="dict" href="careplan-definitions.html#CarePlan.activity.simple.performer" title="Identifies who's expected to be involved in the activity."><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"> Who's responsible?</span><span style="color: Gray"> --></span></performer> <<a class="dict" href="careplan-definitions.html#CarePlan.activity.simple.product" title="Identifies the food, drug or other product being consumed or supplied in the activity."><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> <<a class="dict" href="careplan-definitions.html#CarePlan.activity.simple.dailyAmount" title="Identifies the quantity expected to be consumed in a given day."><b>dailyAmount</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: DailyDose can only be specified if activity category is drug or food"><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> <<a class="dict" href="careplan-definitions.html#CarePlan.activity.simple.quantity" title="Identifies the quantity expected to be supplied."><b>quantity</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-2: Quantity can only be specified if activity category is supply"><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> <<a class="dict" href="careplan-definitions.html#CarePlan.activity.simple.details" 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."><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> </simple> </activity> <<a class="dict" href="careplan-definitions.html#CarePlan.notes" title="General notes about the care plan not covered elsewhere."><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> </CarePlan> </pre></div> </summary> </entry> <entry> <title>"composition" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/composition</id> <link href="http://hl7.org/implement/standards/fhir/composition.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="composition-definitions.html#Composition" 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."><b>Composition</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="composition-definitions.html#Composition.identifier" title="Logical Identifier for the composition, assigned when created. This identifier stays constant as the composition is changed over time."><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"> Logical identifier of composition (version-independent)<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></identifier> <<a class="dict" href="composition-definitions.html#Composition.date" title="The composition editing time, when the composition was last logically changed by the author."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="composition-definitions.html#Composition.type" 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."><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 href="valueset-doc-codes.html" style="color: navy">Kind of composition (LOINC if possible)<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></type> <<a class="dict" href="composition-definitions.html#Composition.class" title="A categorization for the type of the composition. This may be implied by or derived from the code specified in the Composition Type."><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 href="valueset-xds-typecodes.html" style="color: navy">Categorization of Composition<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></class> <<a class="dict" href="composition-definitions.html#Composition.title" title="Official human-readable label for the composition."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="composition-definitions.html#Composition.status" 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)"><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 href="composition-status.html" style="color: navy">preliminary | final | appended | amended | entered in error<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span> <<a class="dict" href="composition-definitions.html#Composition.confidentiality" title="The code specifying the level of confidentiality of the Composition (this element modifies the meaning of other elements)"><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 href="v3/vs/Confidentiality/index.html" style="color: navy">As defined by affinity domain<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a><span style="color: Gray"> --></span></confidentiality> <<a class="dict" href="composition-definitions.html#Composition.subject" 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)."><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"> Who and/or what the composition is about<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></subject> <<a class="dict" href="composition-definitions.html#Composition.author" title="Identifies who is responsible for the information in the composition. (Not necessarily who typed it in.)."><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"> Who and/or what authored the composition<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></author> <<a class="dict" href="composition-definitions.html#Composition.attester" title="A participant who has attested to the accuracy of the composition/document."><b>attester</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Attests to accuracy of composition<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span> --></span> <<a class="dict" href="composition-definitions.html#Composition.attester.mode" title="The type of attestation the authenticator offers."><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 href="composition-attestation-mode.html" style="color: navy">personal | professional | legal | official<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span> <<a class="dict" href="composition-definitions.html#Composition.attester.time" title="When composition was attested by the party."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="composition-definitions.html#Composition.attester.party" title="Who attested the composition in the specified way."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></party> </attester> <<a class="dict" href="composition-definitions.html#Composition.custodian" title="Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></custodian> <<a class="dict" href="composition-definitions.html#Composition.event" title="The main event/act/item, such as a colonoscopy or an appendectomy, being documented."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span> --></span> <<a class="dict" href="composition-definitions.html#Composition.event.code" 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."><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 href="v3/ActCode/index.html" style="color: navy">Code(s) that apply to the event being documented<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a><span style="color: Gray"> --></span></code> <<a class="dict" href="composition-definitions.html#Composition.event.period" 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."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></period> <<a class="dict" href="composition-definitions.html#Composition.event.detail" title="Full details for the event(s) the composition/documentation consents."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></detail> </event> <<a class="dict" href="composition-definitions.html#Composition.encounter" title="Describes the clinical encounter or type of care this documentation is associated with."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></encounter> <<a class="dict" href="composition-definitions.html#Composition.section" title="The root of the sections that make up the composition."><b>section</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Composition is broken into sections --></span> <<a class="dict" href="composition-definitions.html#Composition.section.title" title="The heading for this particular section. This will be part of the rendered content for the document."><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> <<a class="dict" href="composition-definitions.html#Composition.section.code" title="A code identifying the kind of content contained within the section."><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 href="valueset-doc-section-codes.html" style="color: navy">Classification of section (recommended)</a></span><span style="color: Gray"> --></span></code> <<a class="dict" href="composition-definitions.html#Composition.section.subject" title="Identifies the primary subject of the section (this element modifies the meaning of other elements)"><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> <<a class="dict" href="composition-definitions.html#Composition.section.content" title="Identifies the discrete data that provides the content for the section."><b>content</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-2: A section SHALL have content or one or more sections, but not both."><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> <<a class="dict" href="composition-definitions.html#Composition.section.section" title="A nested sub-section within this section."><b>section</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-2: A section SHALL have content or one or more sections, but not both."><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> </section> </Composition> </pre></div> </text> <name value="composition"/> <publisher value="FHIR Project"/> <description value="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 value="draft"/> <date value="2014-09-30"/> <requirements value="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. Note: 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 value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="cda"/> <uri value="http://hl7.org/v3/cda"/> <name value="CDA (R2)"/> </mapping> <structure> <type value="Composition"/> <publish value="true"/> <element> <path value="Composition"/> <definition> <short value="A set of resources composed into a single coherent clinical statement with clinical attestation"/> <formal value="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 value="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 value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Document[classCode="DOC" and moodCode="EVN" and isNormalAct()]"/> </mapping> <mapping> <identity value="cda"/> <map value="ClinicalDocument"/> </mapping> </definition> </element> <element> <path value="Composition.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Composition.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Composition.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Composition.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Composition.identifier"/> <definition> <short value="Logical identifier of composition (version-independent)"/> <formal value="Logical Identifier for the composition, assigned when created. This identifier stays constant as the composition is changed over time."/> <comments value="See discussion in resource definition for how these relate."/> <min value="0"/> <max value="1"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Document.id / Document.setId"/> </mapping> <mapping> <identity value="cda"/> <map value=".setId"/> </mapping> </definition> </element> <element> <path value="Composition.date"/> <definition> <short value="Composition editing time"/> <formal value="The composition editing time, when the composition was last logically changed by the author."/> <comments value="The Last Modified Date on the composition may be after the date of the document was attested without being changed."/> <min value="1"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".effectiveTime[type="TS"]"/> </mapping> <mapping> <identity value="cda"/> <map value=".effectiveTime"/> </mapping> </definition> </element> <element> <path value="Composition.type"/> <definition> <short value="Kind of composition (LOINC if possible)"/> <formal value="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 value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="DocumentType"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/doc-codes"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="./code"/> </mapping> <mapping> <identity value="cda"/> <map value=".code"/> </mapping> </definition> </element> <element> <path value="Composition.class"/> <definition> <short value="Categorization of Composition"/> <formal value="A categorization for the type of the composition. This may be implied by or derived from the code specified in the Composition Type."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="DocumentClass"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/xds-typecodes"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN&quo t;].code"/> </mapping> <mapping> <identity value="cda"/> <map value="n/a"/> </mapping> </definition> </element> <element> <path value="Composition.title"/> <definition> <short value="Human Readable name/title"/> <formal value="Official human-readable label for the composition."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./title"/> </mapping> <mapping> <identity value="cda"/> <map value=".title"/> </mapping> </definition> </element> <element> <path value="Composition.status"/> <definition> <short value="preliminary | final | appended | amended | entered in error"/> <formal value="The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document."/> <comments value="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 value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="CompositionStatus"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/composition-status"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="interim: .completionCode="IN" & ./statusCode[isNormalDatatype()]="active"; final: .completionCode="AU" && ./statusCode[isNormalDatatype()]="complete&q uot; and not(./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[su bsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseCompo sition", code) and isNormalAct()]); amended: .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"]; withdrawn : .completionCode=NI && ./statusCode[isNo rmalDatatype()]="obsolete""/> </mapping> <mapping> <identity value="cda"/> <map value="n/a"/> </mapping> </definition> </element> <element> <path value="Composition.confidentiality"/> <definition> <short value="As defined by affinity domain"/> <formal value="The code specifying the level of confidentiality of the Composition."/> <comments value="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 value="1"/> <max value="1"/> <type> <code value="Coding"/> </type> <isModifier value="true"/> <binding> <name value="DocumentConfidentiality"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/v3/vs/Confidentiality"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".confidentialityCode"/> </mapping> <mapping> <identity value="cda"/> <map value=".confidentialityCode"/> </mapping> </definition> </element> <element> <path value="Composition.subject"/> <definition> <short value="Who and/or what the composition is about"/> <formal value="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 value="For clinical documents, this is usually the patient."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Group"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Device"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Location"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode="SBJ"].role[typeCode="PAT"]"/> </mapping> <mapping> <identity value="cda"/> <map value=".recordTarget"/> </mapping> </definition> </element> <element> <path value="Composition.author"/> <definition> <short value="Who and/or what authored the composition"/> <formal value="Identifies who is responsible for the information in the composition. (Not necessarily who typed it in.)."/> <min value="1"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Device"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/RelatedPerson"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode="AUT"].role[classCode="ASSIGNED"]"/> </mapping> <mapping> <identity value="cda"/> <map value=".author.assignedAuthor"/> </mapping> </definition> </element> <element> <path value="Composition.attester"/> <definition> <short value="Attests to accuracy of composition"/> <formal value="A participant who has attested to the accuracy of the composition/document."/> <comments value="Only list each attester once."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode="AUTHEN"].role[classCode="ASSIGNED"]"/> </mapping> <mapping> <identity value="cda"/> <map value=".authenticator/.legalAuthenticator"/> </mapping> </definition> </element> <element> <path value="Composition.attester.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Composition.attester.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Composition.attester.mode"/> <definition> <short value="personal | professional | legal | official"/> <formal value="The type of attestation the authenticator offers."/> <comments value="Use more than one code where a single attester has more than one mode (professional and legal are often paired)."/> <min value="1"/> <max value="*"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="CompositionAttestationMode"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/composition-attestation-mode"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="unique(./modeCode)"/> </mapping> <mapping> <identity value="cda"/> <map value="implied by .authenticator/.legalAuthenticator"/> </mapping> </definition> </element> <element> <path value="Composition.attester.time"/> <definition> <short value="When composition attested"/> <formal value="When composition was attested by the party."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./time[type="TS" and isNormalDatatype()]"/> </mapping> <mapping> <identity value="cda"/> <map value=".authenticator.time"/> </mapping> </definition> </element> <element> <path value="Composition.attester.party"/> <definition> <short value="Who attested the composition"/> <formal value="Who attested the composition in the specified way."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Organization"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./role[classCode="ASSIGNED" and isNormalRole]/player[determinerCode="INST" and classCode=("DEV", "PSN") and isNormalEntity()] or ./role[classCode="ASS IGNED" and isNormalRole and not(player)]/scoper[determinerCode="INST" and classCode="ORG" and isNormalEntity()]"/> </mapping> <mapping> <identity value="cda"/> <map value=".authenticator.assignedEnttty"/> </mapping> </definition> </element> <element> <path value="Composition.custodian"/> <definition> <short value="Org which maintains the composition"/> <formal value="Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Organization"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode="RCV"].role[classCode="CUST"].scoper[classCode="ORG " and determinerCode="INST"]"/> </mapping> <mapping> <identity value="cda"/> <map value=".custodian.assignedCustodian"/> </mapping> </definition> </element> <element> <path value="Composition.event"/> <definition> <short value="The clinical event/act/item being documented"/> <formal value="The main event/act/item, such as a colonoscopy or an appendectomy, being documented."/> <comments value="The event needs to be consistent with the type element, though can provide further information if desired."/> <min value="0"/> <max value="1"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="outboundRelationship[typeCode="SUBJ"].target[classCode<'ACT']"/> </mapping> <mapping> <identity value="cda"/> <map value=".documentationOf.serviceEvent"/> </mapping> </definition> </element> <element> <path value="Composition.event.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Composition.event.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Composition.event.code"/> <definition> <short value="Code(s) that apply to the event being documented"/> <formal value="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 value="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 value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="DocumentEventType"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/v3/vs/ActCode"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> <mapping> <identity value="cda"/> <map value=".code"/> </mapping> </definition> </element> <element> <path value="Composition.event.period"/> <definition> <short value="The period covered by the documentation"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="Period"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".effectiveTime"/> </mapping> <mapping> <identity value="cda"/> <map value=".effectiveTime"/> </mapping> </definition> </element> <element> <path value="Composition.event.detail"/> <definition> <short value="Full details for the event(s) the composition consents"/> <formal value="Full details for the event(s) the composition/documentation consents."/> <min value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Any"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode="SUBJ"].target"/> </mapping> <mapping> <identity value="cda"/> <map value="n/a"/> </mapping> </definition> </element> <element> <path value="Composition.encounter"/> <definition> <short value="Context of the conposition"/> <formal value="Describes the clinical encounter or type of care this documentation is associated with."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Encounter"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="unique(highest(./outboundRelationship[typeCode="SUBJ" and isNormalActRelationship()], priorityNumber)/target[moodCode="EVN" and classCode=("ENC", "PCPR") and isNormalAct])"/> </mapping> <mapping> <identity value="cda"/> <map value=".componentOf.encompassingEncounter"/> </mapping> </definition> </element> <element> <path value="Composition.section"/> <definition> <short value="Composition is broken into sections"/> <formal value="The root of the sections that make up the composition."/> <min value="0"/> <max value="*"/> <constraint> <key value="2"/> <name value="Section Rule"/> <severity value="error"/> <human value="A section SHALL have content or one or more sections, but not both."/> <xpath value="exists(f:content) != exists(f:section)"/> </constraint> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode=&quo t;EVN" and classCode="DOCSECT" and isNormalAct]"/> </mapping> <mapping> <identity value="cda"/> <map value=".component.structuredBody.component.section"/> </mapping> </definition> </element> <element> <path value="Composition.section.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Composition.section.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Composition.section.title"/> <definition> <short value="Label for section"/> <formal value="The heading for this particular section. This will be part of the rendered content for the document."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./title"/> </mapping> <mapping> <identity value="cda"/> <map value=".title"/> </mapping> </definition> </element> <element> <path value="Composition.section.code"/> <definition> <short value="Classification of section (recommended)"/> <formal value="A code identifying the kind of content contained within the section."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="CompositionSectionType"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/doc-section-codes"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="./code"/> </mapping> <mapping> <identity value="cda"/> <map value=".code"/> </mapping> </definition> </element> <element> <path value="Composition.section.subject"/> <definition> <short value="If section different to composition"/> <formal value="Identifies the primary subject of the section."/> <comments value="This is labeled as "Is Modifier" because applications SHALL be aware if the subject changes for a particular section."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Group"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Device"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="unique(./participation[typeCode="SBJ" and isNormalParticipation]/role[typeCode="PAT&q uot;]) or unique(./participation[typeCode="SBJ" and isNormalParticipation]/role[typeCode=&q uot;IDENT"]/player[determinerCode="INST" and classCode=("DEV", "ORG") and isNormalEntity()])"/> </mapping> <mapping> <identity value="cda"/> <map value=".subject.relatedSubject"/> </mapping> </definition> </element> <element> <path value="Composition.section.content"/> <definition> <short value="The actual data for the section"/> <formal value="Identifies the discrete data that provides the content for the section."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Any"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="unique(./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCo de="EVN" and classCode!="DOCSECT" and isNormalAct])"/> </mapping> <mapping> <identity value="cda"/> <map value="n/a"/> </mapping> </definition> </element> <element> <path value="Composition.section.section"/> <definition> <short value="Nested Section"/> <formal value="A nested sub-section within this section."/> <min value="0"/> <max value="*"/> <nameReference value="Composition.section"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode=&quo t;EVN" and classCode="DOCSECT" and isNormalAct]"/> </mapping> <mapping> <identity value="cda"/> <map value=".component.section"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="attester"/> <type value="reference"/> <documentation value="Who attested the composition"/> <xpath value="f:Composition/f:attester/f:party"/> </searchParam> <searchParam> <name value="author"/> <type value="reference"/> <documentation value="Who and/or what authored the composition"/> <xpath value="f:Composition/f:author"/> </searchParam> <searchParam> <name value="class"/> <type value="token"/> <documentation value="Categorization of Composition"/> <xpath value="f:Composition/f:class"/> </searchParam> <searchParam> <name value="context"/> <type value="token"/> <documentation value="Code(s) that apply to the event being documented"/> <xpath value="f:Composition/f:event/f:code"/> </searchParam> <searchParam> <name value="date"/> <type value="date"/> <documentation value="Composition editing time"/> <xpath value="f:Composition/f:date"/> </searchParam> <searchParam> <name value="identifier"/> <type value="token"/> <documentation value="Logical identifier of composition (version-independent)"/> <xpath value="f:Composition/f:identifier"/> </searchParam> <searchParam> <name value="section-content"/> <type value="reference"/> <documentation value="The actual data for the section"/> <xpath value="f:Composition/f:section/f:content"/> </searchParam> <searchParam> <name value="section-type"/> <type value="token"/> <documentation value="Classification of section (recommended)"/> <xpath value="f:Composition/f:section/f:code"/> </searchParam> <searchParam> <name value="subject"/> <type value="reference"/> <documentation value="Who and/or what the composition is about"/> <xpath value="f:Composition/f:subject"/> </searchParam> <searchParam> <name value="type"/> <type value="token"/> <documentation value="Kind of composition (LOINC if possible)"/> <xpath value="f:Composition/f:type"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="composition-definitions.html#Composition" 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."><b>Composition</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="composition-definitions.html#Composition.identifier" title="Logical Identifier for the composition, assigned when created. This identifier stays constant as the composition is changed over time."><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"> Logical identifier of composition (version-independent)<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></identifier> <<a class="dict" href="composition-definitions.html#Composition.date" title="The composition editing time, when the composition was last logically changed by the author."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="composition-definitions.html#Composition.type" 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."><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 href="valueset-doc-codes.html" style="color: navy">Kind of composition (LOINC if possible)<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></type> <<a class="dict" href="composition-definitions.html#Composition.class" title="A categorization for the type of the composition. This may be implied by or derived from the code specified in the Composition Type."><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 href="valueset-xds-typecodes.html" style="color: navy">Categorization of Composition<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></class> <<a class="dict" href="composition-definitions.html#Composition.title" title="Official human-readable label for the composition."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="composition-definitions.html#Composition.status" 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)"><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 href="composition-status.html" style="color: navy">preliminary | final | appended | amended | entered in error<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span> <<a class="dict" href="composition-definitions.html#Composition.confidentiality" title="The code specifying the level of confidentiality of the Composition (this element modifies the meaning of other elements)"><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 href="v3/vs/Confidentiality/index.html" style="color: navy">As defined by affinity domain<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a><span style="color: Gray"> --></span></confidentiality> <<a class="dict" href="composition-definitions.html#Composition.subject" 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)."><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"> Who and/or what the composition is about<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></subject> <<a class="dict" href="composition-definitions.html#Composition.author" title="Identifies who is responsible for the information in the composition. (Not necessarily who typed it in.)."><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"> Who and/or what authored the composition<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></author> <<a class="dict" href="composition-definitions.html#Composition.attester" title="A participant who has attested to the accuracy of the composition/document."><b>attester</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Attests to accuracy of composition<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span> --></span> <<a class="dict" href="composition-definitions.html#Composition.attester.mode" title="The type of attestation the authenticator offers."><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 href="composition-attestation-mode.html" style="color: navy">personal | professional | legal | official<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span> <<a class="dict" href="composition-definitions.html#Composition.attester.time" title="When composition was attested by the party."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="composition-definitions.html#Composition.attester.party" title="Who attested the composition in the specified way."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></party> </attester> <<a class="dict" href="composition-definitions.html#Composition.custodian" title="Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></custodian> <<a class="dict" href="composition-definitions.html#Composition.event" title="The main event/act/item, such as a colonoscopy or an appendectomy, being documented."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span> --></span> <<a class="dict" href="composition-definitions.html#Composition.event.code" 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."><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 href="v3/ActCode/index.html" style="color: navy">Code(s) that apply to the event being documented<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a><span style="color: Gray"> --></span></code> <<a class="dict" href="composition-definitions.html#Composition.event.period" 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."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></period> <<a class="dict" href="composition-definitions.html#Composition.event.detail" title="Full details for the event(s) the composition/documentation consents."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></detail> </event> <<a class="dict" href="composition-definitions.html#Composition.encounter" title="Describes the clinical encounter or type of care this documentation is associated with."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></encounter> <<a class="dict" href="composition-definitions.html#Composition.section" title="The root of the sections that make up the composition."><b>section</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Composition is broken into sections --></span> <<a class="dict" href="composition-definitions.html#Composition.section.title" title="The heading for this particular section. This will be part of the rendered content for the document."><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> <<a class="dict" href="composition-definitions.html#Composition.section.code" title="A code identifying the kind of content contained within the section."><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 href="valueset-doc-section-codes.html" style="color: navy">Classification of section (recommended)</a></span><span style="color: Gray"> --></span></code> <<a class="dict" href="composition-definitions.html#Composition.section.subject" title="Identifies the primary subject of the section (this element modifies the meaning of other elements)"><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> <<a class="dict" href="composition-definitions.html#Composition.section.content" title="Identifies the discrete data that provides the content for the section."><b>content</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-2: A section SHALL have content or one or more sections, but not both."><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> <<a class="dict" href="composition-definitions.html#Composition.section.section" title="A nested sub-section within this section."><b>section</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-2: A section SHALL have content or one or more sections, but not both."><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> </section> </Composition> </pre></div> </summary> </entry> <entry> <title>"conceptmap" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/conceptmap</id> <link href="http://hl7.org/implement/standards/fhir/conceptmap.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="conceptmap-definitions.html#ConceptMap" title="A statement of relationships from one set of concepts to one or more other concept systems."><b>ConceptMap</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.identifier" 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)."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.version" 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."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.name" title="A free text natural language name describing the concept map."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.publisher" title="The name of the individual or organization that published the concept map."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.telecom" title="Contacts of the publisher to assist a user in finding and communicating with the publisher."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></telecom> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.description" title="A free text natural language description of the use of the concept map - reason for definition, conditions of use, etc."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.copyright" title="A copyright statement relating to the concept map and/or its contents."><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> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.status" title="The status of the concept map (this element modifies the meaning of other elements)"><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 href="valueset-status.html" style="color: navy">draft | active | retired<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.experimental" title="This ConceptMap was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.date" title="The date that the concept map status was last changed."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.source" title="The source value set that specifies the concepts that are being mapped."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></source> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.target" 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."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></target> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.concept" title="Mappings for a concept from the source valueset."><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> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.concept.system" title="System that defines the concept being mapped."><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> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.concept.code" title="Identifies concept being mapped."><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> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.concept.dependsOn" 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."><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> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.concept.dependsOn.concept" 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."><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> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.concept.dependsOn.system" title="System for a concept in the referenced concept."><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> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.concept.dependsOn.code" title="Code for a concept in the referenced concept."><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> </dependsOn> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.concept.map" title="A concept from the target value set that this concept maps to."><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> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.concept.map.system" title="System of the target."><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" title="Inv-2: If a code is provided, a system SHALL be provided"><b><img alt="??" src="lock.png"/> 0..1</b></span> <span style="color: navy">System of the target</span><span style="color: Gray"> --></span> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.concept.map.code" title="Code that identifies the target concept."><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> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.concept.map.equivalence" title="equal | equivalent | wider | subsumes | narrower | specialises | inexact | unmatched | disjoint (this element modifies the meaning of other elements)"><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 href="concept-equivalence.html" style="color: navy">equal | equivalent | wider | subsumes | narrower | specialises | inexact | unmatched | disjoint</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.concept.map.comments" title="Description of status/issues in mapping."><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" title="Inv-1: If the map is narrower, there SHALL be some comments"><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> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.concept.map.product" 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."><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> </map> </concept> </ConceptMap> </pre></div> </text> <name value="conceptmap"/> <publisher value="FHIR Project"/> <description value="Basic Profile. A statement of relationships from one set of concepts to one or more other concept systems."/> <status value="draft"/> <date value="2014-09-30"/> <requirements value="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 value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <structure> <type value="ConceptMap"/> <publish value="true"/> <element> <path value="ConceptMap"/> <definition> <short value="A statement of relationships from one set of concepts to one or more other concept systems"/> <formal value="A statement of relationships from one set of concepts to one or more other concept systems."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </definition> </element> <element> <path value="ConceptMap.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ConceptMap.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ConceptMap.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ConceptMap.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ConceptMap.identifier"/> <definition> <short value="Logical id to reference this concept map"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </definition> </element> <element> <path value="ConceptMap.version"/> <definition> <short value="Logical id for this version of the concept map"/> <formal value="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 value="There may be multiple resource versions of the concept map that have this same identifier."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </definition> </element> <element> <path value="ConceptMap.name"/> <definition> <short value="Informal name for this concept map"/> <formal value="A free text natural language name describing the concept map."/> <comments value="Not expected to be unique."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </definition> </element> <element> <path value="ConceptMap.publisher"/> <definition> <short value="Name of the publisher (Organization or individual)"/> <formal value="The name of the individual or organization that published the concept map."/> <comments value="Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ConceptMap.telecom"/> <definition> <short value="Contact information of the publisher"/> <formal value="Contacts of the publisher to assist a user in finding and communicating with the publisher."/> <comments value="May be a web site, an email address, a telephone number (tel:), etc."/> <min value="0"/> <max value="*"/> <type> <code value="Contact"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ConceptMap.description"/> <definition> <short value="Human language description of the concept map"/> <formal value="A free text natural language description of the use of the concept map - reason for definition, conditions of use, etc."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </definition> </element> <element> <path value="ConceptMap.copyright"/> <definition> <short value="About the concept map or its content"/> <formal value="A copyright statement relating to the concept map and/or its contents."/> <comments value="Frequently, the copyright differs between the concept map, and codes that are included. The copyright statement should clearly differentiate between these when required."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ConceptMap.status"/> <definition> <short value="draft | active | retired"/> <formal value="The status of the concept map."/> <comments value="Allows filtering of ConceptMaps that are appropriate for use."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="ValueSetStatus"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/valueset-status"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </definition> </element> <element> <path value="ConceptMap.experimental"/> <definition> <short value="If for testing purposes, not real usage"/> <formal value="This ConceptMap was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage."/> <comments value="Allows filtering of ConceptMaps that are appropriate for use."/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ConceptMap.date"/> <definition> <short value="Date for given status"/> <formal value="The date that the concept map status was last changed."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </definition> </element> <element> <path value="ConceptMap.source"/> <definition> <short value="Identifies the source value set which is being mapped"/> <formal value="The source value set that specifies the concepts that are being mapped."/> <comments value="Should be a version specific reference."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/ValueSet"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ConceptMap.target"/> <definition> <short value="Provides context to the mappings"/> <formal value="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 value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/ValueSet"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ConceptMap.concept"/> <definition> <short value="Mappings for a concept from the source valueset"/> <formal value="Mappings for a concept from the source valueset."/> <comments value="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 value="0"/> <max value="*"/> <isModifier value="false"/> </definition> </element> <element> <path value="ConceptMap.concept.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ConceptMap.concept.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ConceptMap.concept.system"/> <definition> <short value="System that defines the concept being mapped"/> <formal value="System that defines the concept being mapped."/> <min value="1"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ConceptMap.concept.code"/> <definition> <short value="Identifies concept being mapped"/> <formal value="Identifies concept being mapped."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ConceptMap.concept.dependsOn"/> <definition> <short value="Other concepts required for this mapping (from context)"/> <formal value="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 value="0"/> <max value="*"/> <isModifier value="false"/> </definition> </element> <element> <path value="ConceptMap.concept.dependsOn.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ConceptMap.concept.dependsOn.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ConceptMap.concept.dependsOn.concept"/> <definition> <short value="Reference to element/field/valueset provides the context"/> <formal value="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 value="1"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ConceptMap.concept.dependsOn.system"/> <definition> <short value="System for a concept in the referenced concept"/> <formal value="System for a concept in the referenced concept."/> <min value="1"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ConceptMap.concept.dependsOn.code"/> <definition> <short value="Code for a concept in the referenced concept"/> <formal value="Code for a concept in the referenced concept."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ConceptMap.concept.map"/> <definition> <short value="A concept from the target value set that this concept maps to"/> <formal value="A concept from the target value set that this concept maps to."/> <comments value="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 value="0"/> <max value="*"/> <constraint> <key value="2"/> <severity value="error"/> <human value="If a code is provided, a system SHALL be provided"/> <xpath value="exists(f:system) or not(exists(f:code))"/> </constraint> <constraint> <key value="1"/> <severity value="error"/> <human value="If the map is narrower, there SHALL be some comments"/> <xpath value="exists(f:comments) or ((f:equivalence/@value != 'narrower') and (f:equivalence/@value != 'inexact'))"/> </constraint> <isModifier value="false"/> </definition> </element> <element> <path value="ConceptMap.concept.map.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ConceptMap.concept.map.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ConceptMap.concept.map.system"/> <definition> <short value="System of the target"/> <formal value="System of the target."/> <comments value="Should be a version specific reference."/> <min value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ConceptMap.concept.map.code"/> <definition> <short value="Code that identifies the target concept"/> <formal value="Code that identifies the target concept."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ConceptMap.concept.map.equivalence"/> <definition> <short value="equal | equivalent | wider | subsumes | narrower | specialises | inexact | unmatched | disjoint"/> <formal value="equal | equivalent | wider | subsumes | narrower | specialises | inexact | unmatched | disjoint."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="ConceptMapEquivalence"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/concept-equivalence"/> </referenceResource> </binding> </definition> </element> <element> <path value="ConceptMap.concept.map.comments"/> <definition> <short value="Description of status/issues in mapping"/> <formal value="Description of status/issues in mapping."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ConceptMap.concept.map.product"/> <definition> <short value="Other concepts that this mapping also produces"/> <formal value="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 value="0"/> <max value="*"/> <nameReference value="ConceptMap.concept.dependsOn"/> <isModifier value="false"/> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="date"/> <type value="date"/> <documentation value="The concept map publication date"/> <xpath value="f:ConceptMap/f:date"/> </searchParam> <searchParam> <name value="dependson"/> <type value="token"/> <documentation value="Reference to element/field/valueset provides the context"/> <xpath value="f:ConceptMap/f:concept/f:dependsOn/f:concept"/> </searchParam> <searchParam> <name value="description"/> <type value="string"/> <documentation value="Text search in the description of the concept map"/> <xpath value="f:ConceptMap/f:description"/> </searchParam> <searchParam> <name value="identifier"/> <type value="token"/> <documentation value="The identifier of the concept map"/> <xpath value="f:ConceptMap/f:identifier"/> </searchParam> <searchParam> <name value="name"/> <type value="string"/> <documentation value="Name of the concept map"/> <xpath value="f:ConceptMap/f:name"/> </searchParam> <searchParam> <name value="product"/> <type value="token"/> <documentation value="Reference to element/field/valueset provides the context"/> <xpath value="f:ConceptMap/f:concept/f:map/f:product/f:concept"/> </searchParam> <searchParam> <name value="publisher"/> <type value="string"/> <documentation value="Name of the publisher of the concept map"/> <xpath value="f:ConceptMap/f:publisher"/> </searchParam> <searchParam> <name value="source"/> <type value="reference"/> <documentation value="The system for any concepts mapped by this concept map"/> <xpath value="f:ConceptMap/f:source"/> </searchParam> <searchParam> <name value="status"/> <type value="token"/> <documentation value="Status of the concept map"/> <xpath value="f:ConceptMap/f:status"/> </searchParam> <searchParam> <name value="system"/> <type value="token"/> <documentation value="The system for any destination concepts mapped by this map"/> <xpath value="f:ConceptMap/f:concept/f:map/f:system"/> </searchParam> <searchParam> <name value="target"/> <type value="reference"/> <documentation value="Provides context to the mappings"/> <xpath value="f:ConceptMap/f:target"/> </searchParam> <searchParam> <name value="version"/> <type value="token"/> <documentation value="The version identifier of the concept map"/> <xpath value="f:ConceptMap/f:version"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="conceptmap-definitions.html#ConceptMap" title="A statement of relationships from one set of concepts to one or more other concept systems."><b>ConceptMap</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.identifier" 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)."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.version" 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."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.name" title="A free text natural language name describing the concept map."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.publisher" title="The name of the individual or organization that published the concept map."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.telecom" title="Contacts of the publisher to assist a user in finding and communicating with the publisher."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></telecom> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.description" title="A free text natural language description of the use of the concept map - reason for definition, conditions of use, etc."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.copyright" title="A copyright statement relating to the concept map and/or its contents."><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> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.status" title="The status of the concept map (this element modifies the meaning of other elements)"><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 href="valueset-status.html" style="color: navy">draft | active | retired<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.experimental" title="This ConceptMap was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.date" title="The date that the concept map status was last changed."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.source" title="The source value set that specifies the concepts that are being mapped."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></source> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.target" 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."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></target> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.concept" title="Mappings for a concept from the source valueset."><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> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.concept.system" title="System that defines the concept being mapped."><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> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.concept.code" title="Identifies concept being mapped."><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> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.concept.dependsOn" 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."><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> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.concept.dependsOn.concept" 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."><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> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.concept.dependsOn.system" title="System for a concept in the referenced concept."><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> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.concept.dependsOn.code" title="Code for a concept in the referenced concept."><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> </dependsOn> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.concept.map" title="A concept from the target value set that this concept maps to."><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> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.concept.map.system" title="System of the target."><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" title="Inv-2: If a code is provided, a system SHALL be provided"><b><img alt="??" src="lock.png"/> 0..1</b></span> <span style="color: navy">System of the target</span><span style="color: Gray"> --></span> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.concept.map.code" title="Code that identifies the target concept."><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> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.concept.map.equivalence" title="equal | equivalent | wider | subsumes | narrower | specialises | inexact | unmatched | disjoint (this element modifies the meaning of other elements)"><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 href="concept-equivalence.html" style="color: navy">equal | equivalent | wider | subsumes | narrower | specialises | inexact | unmatched | disjoint</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.concept.map.comments" title="Description of status/issues in mapping."><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" title="Inv-1: If the map is narrower, there SHALL be some comments"><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> <<a class="dict" href="conceptmap-definitions.html#ConceptMap.concept.map.product" 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."><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> </map> </concept> </ConceptMap> </pre></div> </summary> </entry> <entry> <title>"condition" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/condition</id> <link href="http://hl7.org/implement/standards/fhir/condition.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="condition-definitions.html#Condition" 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."><b>Condition</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="condition-definitions.html#Condition.identifier" 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)."><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> <<a class="dict" href="condition-definitions.html#Condition.subject" title="Indicates the patient who the condition record is associated with."><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> <<a class="dict" href="condition-definitions.html#Condition.encounter" title="Encounter during which the condition was first asserted."><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> <<a class="dict" href="condition-definitions.html#Condition.asserter" title="Person who takes responsibility for asserting the existence of the condition as part of the electronic record."><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> <<a class="dict" href="condition-definitions.html#Condition.dateAsserted" title="Estimated or actual date the condition/problem/diagnosis was first detected/suspected."><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> <<a class="dict" href="condition-definitions.html#Condition.code" title="Identification of the condition, problem or diagnosis."><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 href="valueset-condition-code.html" style="color: navy">Identification of the condition, problem or diagnosis</a></span><span style="color: Gray"> --></span></code> <<a class="dict" href="condition-definitions.html#Condition.category" title="A category assigned to the condition. E.g. complaint | symptom | finding | diagnosis."><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 href="valueset-condition-category.html" style="color: navy">E.g. complaint | symptom | finding | diagnosis</a></span><span style="color: Gray"> --></span></category> <<a class="dict" href="condition-definitions.html#Condition.status" title="The clinical status of the condition (this element modifies the meaning of other elements)"><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 href="condition-status.html" style="color: navy">provisional | working | confirmed | refuted</a></span><span style="color: Gray"> --></span> <<a class="dict" href="condition-definitions.html#Condition.certainty" title="The degree of confidence that this condition is correct (this element modifies the meaning of other elements)"><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 href="valueset-condition-certainty.html" style="color: navy">Degree of confidence</a></span><span style="color: Gray"> --></span></certainty> <<a class="dict" href="condition-definitions.html#Condition.severity" title="A subjective assessment of the severity of the condition as evaluated by the clinician."><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 href="valueset-condition-severity.html" style="color: navy">Subjective severity of condition</a></span><span style="color: Gray"> --></span></severity> <<a class="dict" href="condition-definitions.html#Condition.onset_x_" title="Estimated or actual date the condition began, in the opinion of the clinician."><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]> <<a class="dict" href="condition-definitions.html#Condition.abatement_x_" 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."><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]> <<a class="dict" href="condition-definitions.html#Condition.stage" title="Clinical stage or grade of a condition. May include formal severity assessments."><b>stage</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..1</b></span> Stage/grade, usually assessed formally --></span> <<a class="dict" href="condition-definitions.html#Condition.stage.summary" title="A simple summary of the stage such as "Stage 3". The determination of the stage is disease-specific."><b>summary</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: Stage SHALL have summary or assessment"><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> <<a class="dict" href="condition-definitions.html#Condition.stage.assessment" title="Reference to a formal record of the evidence on which the staging assessment is based."><b>assessment</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: Stage SHALL have summary or assessment"><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> </stage> <<a class="dict" href="condition-definitions.html#Condition.evidence" title="Supporting Evidence / manifestations that are the basis on which this condition is suspected or confirmed."><b>evidence</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Supporting evidence --></span> <<a class="dict" href="condition-definitions.html#Condition.evidence.code" title="A manifestation or symptom that led to the recording of this condition."><b>code</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-2: evidence SHALL have code or details"><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> <<a class="dict" href="condition-definitions.html#Condition.evidence.detail" title="Links to other relevant information, including pathology reports."><b>detail</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-2: evidence SHALL have code or details"><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> </evidence> <<a class="dict" href="condition-definitions.html#Condition.location" title="The anatomical location where this condition manifests itself."><b>location</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Anatomical location, if relevant --></span> <<a class="dict" href="condition-definitions.html#Condition.location.code" title="Code that identifies the structural location."><b>code</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-3: location SHALL have code or details"><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> <<a class="dict" href="condition-definitions.html#Condition.location.detail" title="Detailed anatomical location information."><b>detail</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-3: location SHALL have code or details"><b><img alt="??" src="lock.png"/> 0..1</b></span> <span style="color: navy">Precise location details</span><span style="color: Gray"> --></span> </location> <<a class="dict" href="condition-definitions.html#Condition.relatedItem" 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."><b>relatedItem</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Causes or precedents for this Condition --></span> <<a class="dict" href="condition-definitions.html#Condition.relatedItem.type" title="The type of relationship that this condition has to the related item."><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 href="condition-relationship-type.html" style="color: navy">due-to | following</a></span><span style="color: Gray"> --></span> <<a class="dict" href="condition-definitions.html#Condition.relatedItem.code" title="Code that identifies the target of this relationship. The code takes the place of a detailed instance target."><b>code</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-4: Relationship SHALL have either a code or a target"><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 href="valueset-condition-code.html" style="color: navy">Relationship target by means of a predefined code</a></span><span style="color: Gray"> --></span></code> <<a class="dict" href="condition-definitions.html#Condition.relatedItem.target" title="Target of the relationship."><b>target</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-4: Relationship SHALL have either a code or a target"><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>| <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> </relatedItem> <<a class="dict" href="condition-definitions.html#Condition.notes" title="Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis."><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> </Condition> </pre></div> </text> <name value="condition"/> <publisher value="FHIR Project"/> <description value="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 value="draft"/> <date value="2014-09-30"/> <requirements value="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. The 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). Conditions are frequently referenced by other resources as "reasons" for an action (Prescription, Procedure, DiagnosticOrder, etc.) The conditions represented in this resources are sometimes described as "Problems", and kept as part of a problem list."/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <structure> <type value="Condition"/> <publish value="true"/> <element> <path value="Condition"/> <definition> <short value="Detailed information about conditions, problems or diagnoses"/> <formal value="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 value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Observation[classCode=OBS, moodCode=EVN, code=ASSERTION, value<Diagnosis]"/> </mapping> <mapping> <identity value="v2"/> <map value="PPR message"/> </mapping> </definition> </element> <element> <path value="Condition.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Condition.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Condition.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Condition.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Condition.identifier"/> <definition> <short value="External Ids for this condition"/> <formal value="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 value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> </definition> </element> <element> <path value="Condition.subject"/> <definition> <short value="Who has the condition?"/> <formal value="Indicates the patient who the condition record is associated with."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=SBJ].role[classCode=PAT]"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-3"/> </mapping> </definition> </element> <element> <path value="Condition.encounter"/> <definition> <short value="Encounter when condition first asserted"/> <formal value="Encounter during which the condition was first asserted."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Encounter"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"/> </mapping> <mapping> <identity value="v2"/> <map value="PV1-19 (+PV1-54)"/> </mapping> </definition> </element> <element> <path value="Condition.asserter"/> <definition> <short value="Person who asserts this condition"/> <formal value="Person who takes responsibility for asserting the existence of the condition as part of the electronic record."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=AUT].role"/> </mapping> <mapping> <identity value="v2"/> <map value="REL-7.1 identifier + REL-7.12 type code"/> </mapping> </definition> </element> <element> <path value="Condition.dateAsserted"/> <definition> <short value="When first detected/suspected/entered"/> <formal value="Estimated or actual date the condition/problem/diagnosis was first detected/suspected."/> <min value="0"/> <max value="1"/> <type> <code value="date"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=AUT].time"/> </mapping> <mapping> <identity value="v2"/> <map value="REL-11"/> </mapping> </definition> </element> <element> <path value="Condition.code"/> <definition> <short value="Identification of the condition, problem or diagnosis"/> <formal value="Identification of the condition, problem or diagnosis."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="ConditionKind"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/condition-code"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".value"/> </mapping> <mapping> <identity value="v2"/> <map value="PRB-3"/> </mapping> </definition> </element> <element> <path value="Condition.category"/> <definition> <short value="E.g. complaint | symptom | finding | diagnosis"/> <formal value="A category assigned to the condition. E.g. complaint | symptom | finding | diagnosis."/> <comments value="The categorization is often highly contextual and may appear poorly differentiated or not very useful in other contexts."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="ConditionCategory"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/condition-category"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> <mapping> <identity value="v2"/> <map value="'problem' if from PRB-3. 'diagnosis' if from DG1 segment in PV1 message"/> </mapping> </definition> </element> <element> <path value="Condition.status"/> <definition> <short value="provisional | working | confirmed | refuted"/> <formal value="The clinical status of the condition."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="ConditionStatus"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/condition-status"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".code (pre or post-coordinated in) Can use valueNegationInd for refuted"/> </mapping> <mapping> <identity value="v2"/> <map value="PRB-14 / DG1-6"/> </mapping> </definition> </element> <element> <path value="Condition.certainty"/> <definition> <short value="Degree of confidence"/> <formal value="The degree of confidence that this condition is correct."/> <comments value="May be a percentage."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="true"/> <binding> <name value="ConditionCertainty"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/condition-certainty"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".uncertaintyCode"/> </mapping> <mapping> <identity value="v2"/> <map value="PRB-19"/> </mapping> </definition> </element> <element> <path value="Condition.severity"/> <definition> <short value="Subjective severity of condition"/> <formal value="A subjective assessment of the severity of the condition as evaluated by the clinician."/> <comments value="Coding of the severity with a terminology is preferred, where possible."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="ConditionSeverity"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/condition-severity"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="Can be pre/post-coordinated into value. Or ./inboundRelationship[typeCode=SUBJ].source[classCode=OB S, moodCode=EVN, code="severity"].value"/> </mapping> <mapping> <identity value="v2"/> <map value="PRB-26 / ABS-3"/> </mapping> </definition> </element> <element> <path value="Condition.onset[x]"/> <definition> <short value="Estimated or actual date, or age"/> <formal value="Estimated or actual date the condition began, in the opinion of the clinician."/> <comments value="Age is generally used when the patient reports an age at which the Condition began to occur."/> <min value="0"/> <max value="1"/> <type> <code value="date"/> </type> <type> <code value="Age"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".effectiveTime.low or .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="age at onset"].value"/> </mapping> <mapping> <identity value="v2"/> <map value="PRB-16"/> </mapping> </definition> </element> <element> <path value="Condition.abatement[x]"/> <definition> <short value="If/when in resolution/remission"/> <formal value="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 value="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. If 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 value="0"/> <max value="1"/> <type> <code value="date"/> </type> <type> <code value="Age"/> </type> <type> <code value="boolean"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".effectiveTime.high or .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="age at remission"].value or .inboundRelationship[typeCode=SUBJ]source[classCode=CONC , moodCode=EVN].status=completed"/> </mapping> </definition> </element> <element> <path value="Condition.stage"/> <definition> <short value="Stage/grade, usually assessed formally"/> <formal value="Clinical stage or grade of a condition. May include formal severity assessments."/> <min value="0"/> <max value="1"/> <constraint> <key value="1"/> <name value="Stage rule"/> <severity value="error"/> <human value="Stage SHALL have summary or assessment"/> <xpath value="exists(f:summary) or exists(f:assessment)"/> </constraint> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="stage/grade" ;]"/> </mapping> </definition> </element> <element> <path value="Condition.stage.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Condition.stage.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Condition.stage.summary"/> <definition> <short value="Simple summary (disease specific)"/> <formal value="A simple summary of the stage such as "Stage 3". The determination of the stage is disease-specific."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".value"/> </mapping> </definition> </element> <element> <path value="Condition.stage.assessment"/> <definition> <short value="Formal record of assessment"/> <formal value="Reference to a formal record of the evidence on which the staging assessment is based."/> <min value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Any"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".self"/> </mapping> </definition> </element> <element> <path value="Condition.evidence"/> <definition> <short value="Supporting evidence"/> <formal value="Supporting Evidence / manifestations that are the basis on which this condition is suspected or confirmed."/> <comments value="The evidence may be a simple list of coded symptoms/manifestations, or references to observations or formal assessments, or both."/> <min value="0"/> <max value="*"/> <constraint> <key value="2"/> <name value="Evidence"/> <severity value="error"/> <human value="evidence SHALL have code or details"/> <xpath value="exists(f:code) or exists(f:detail)"/> </constraint> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=SPRT].target[classCode=OBS, moodCode=EVN]"/> </mapping> </definition> </element> <element> <path value="Condition.evidence.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Condition.evidence.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Condition.evidence.code"/> <definition> <short value="Manifestation/symptom"/> <formal value="A manifestation or symptom that led to the recording of this condition."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="[code="diagnosis"].value"/> </mapping> </definition> </element> <element> <path value="Condition.evidence.detail"/> <definition> <short value="Supporting information found elsewhere"/> <formal value="Links to other relevant information, including pathology reports."/> <min value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Any"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".self"/> </mapping> </definition> </element> <element> <path value="Condition.location"/> <definition> <short value="Anatomical location, if relevant"/> <formal value="The anatomical location where this condition manifests itself."/> <comments value="May be a summary code, or a reference to a very precise definition of the location, or both."/> <min value="0"/> <max value="*"/> <constraint> <key value="3"/> <name value="Location"/> <severity value="error"/> <human value="location SHALL have code or details"/> <xpath value="exists(f:code) or exists(f:detail)"/> </constraint> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".targetBodySiteCode"/> </mapping> </definition> </element> <element> <path value="Condition.location.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Condition.location.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Condition.location.code"/> <definition> <short value="Location - may include laterality"/> <formal value="Code that identifies the structural location."/> <comments value="May include laterality."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".self"/> </mapping> </definition> </element> <element> <path value="Condition.location.detail"/> <definition> <short value="Precise location details"/> <formal value="Detailed anatomical location information."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".originalText"/> </mapping> </definition> </element> <element> <path value="Condition.relatedItem"/> <definition> <short value="Causes or precedents for this Condition"/> <formal value="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 value="Although a condition may be caused by a substance, this is not intended to be used to record allergies/adverse reactions to substances."/> <min value="0"/> <max value="*"/> <constraint> <key value="4"/> <name value="Relationship"/> <severity value="error"/> <human value="Relationship SHALL have either a code or a target"/> <xpath value="exists(f:code) != exists(f:target)"/> </constraint> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=RSON, SAS]"/> </mapping> <mapping> <identity value="v2"/> <map value="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"/> </mapping> </definition> </element> <element> <path value="Condition.relatedItem.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Condition.relatedItem.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Condition.relatedItem.type"/> <definition> <short value="due-to | following"/> <formal value="The type of relationship that this condition has to the related item."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="ConditionRelationshipType"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/condition-relationship-type"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".typeCode"/> </mapping> </definition> </element> <element> <path value="Condition.relatedItem.code"/> <definition> <short value="Relationship target by means of a predefined code"/> <formal value="Code that identifies the target of this relationship. The code takes the place of a detailed instance target."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="ConditionKind"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/condition-code"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".target[classCode=OBS, moodCode=EVN].code"/> </mapping> </definition> </element> <element> <path value="Condition.relatedItem.target"/> <definition> <short value="Relationship target resource"/> <formal value="Target of the relationship."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Condition"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Procedure"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/MedicationAdministration"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Immunization"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/MedicationStatement"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".target[classCode=OBS, moodCode=EVN]"/> </mapping> </definition> </element> <element> <path value="Condition.notes"/> <definition> <short value="Additional information about the Condition"/> <formal value="Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="annotation"] .value"/> </mapping> <mapping> <identity value="v2"/> <map value="NTE child of PRB"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="asserter"/> <type value="reference"/> <documentation value="Person who asserts this condition"/> <xpath value="f:Condition/f:asserter"/> </searchParam> <searchParam> <name value="category"/> <type value="token"/> <documentation value="The category of the condition"/> <xpath value="f:Condition/f:category"/> </searchParam> <searchParam> <name value="code"/> <type value="token"/> <documentation value="Code for the condition"/> <xpath value="f:Condition/f:code"/> </searchParam> <searchParam> <name value="date-asserted"/> <type value="date"/> <documentation value="When first detected/suspected/entered"/> <xpath value="f:Condition/f:dateAsserted"/> </searchParam> <searchParam> <name value="encounter"/> <type value="reference"/> <documentation value="Encounter when condition first asserted"/> <xpath value="f:Condition/f:encounter"/> </searchParam> <searchParam> <name value="evidence"/> <type value="token"/> <documentation value="Manifestation/symptom"/> <xpath value="f:Condition/f:evidence/f:code"/> </searchParam> <searchParam> <name value="location"/> <type value="token"/> <documentation value="Location - may include laterality"/> <xpath value="f:Condition/f:location/f:code"/> </searchParam> <searchParam> <name value="onset"/> <type value="date"/> <documentation value="When the Condition started (if started on a date)"/> <xpath value="f:Condition/f:onset[x]"/> </searchParam> <searchParam> <name value="related-code"/> <type value="token"/> <documentation value="Relationship target by means of a predefined code"/> <xpath value="f:Condition/f:relatedItem/f:code"/> </searchParam> <searchParam> <name value="related-item"/> <type value="reference"/> <documentation value="Relationship target resource"/> <xpath value="f:Condition/f:relatedItem/f:target"/> </searchParam> <searchParam> <name value="severity"/> <type value="token"/> <documentation value="The severity of the condition"/> <xpath value="f:Condition/f:severity"/> </searchParam> <searchParam> <name value="stage"/> <type value="token"/> <documentation value="Simple summary (disease specific)"/> <xpath value="f:Condition/f:stage/f:summary"/> </searchParam> <searchParam> <name value="status"/> <type value="token"/> <documentation value="The status of the condition"/> <xpath value="f:Condition/f:status"/> </searchParam> <searchParam> <name value="subject"/> <type value="reference"/> <documentation value="Who has the condition?"/> <xpath value="f:Condition/f:subject"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="condition-definitions.html#Condition" 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."><b>Condition</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="condition-definitions.html#Condition.identifier" 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)."><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> <<a class="dict" href="condition-definitions.html#Condition.subject" title="Indicates the patient who the condition record is associated with."><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> <<a class="dict" href="condition-definitions.html#Condition.encounter" title="Encounter during which the condition was first asserted."><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> <<a class="dict" href="condition-definitions.html#Condition.asserter" title="Person who takes responsibility for asserting the existence of the condition as part of the electronic record."><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> <<a class="dict" href="condition-definitions.html#Condition.dateAsserted" title="Estimated or actual date the condition/problem/diagnosis was first detected/suspected."><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> <<a class="dict" href="condition-definitions.html#Condition.code" title="Identification of the condition, problem or diagnosis."><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 href="valueset-condition-code.html" style="color: navy">Identification of the condition, problem or diagnosis</a></span><span style="color: Gray"> --></span></code> <<a class="dict" href="condition-definitions.html#Condition.category" title="A category assigned to the condition. E.g. complaint | symptom | finding | diagnosis."><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 href="valueset-condition-category.html" style="color: navy">E.g. complaint | symptom | finding | diagnosis</a></span><span style="color: Gray"> --></span></category> <<a class="dict" href="condition-definitions.html#Condition.status" title="The clinical status of the condition (this element modifies the meaning of other elements)"><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 href="condition-status.html" style="color: navy">provisional | working | confirmed | refuted</a></span><span style="color: Gray"> --></span> <<a class="dict" href="condition-definitions.html#Condition.certainty" title="The degree of confidence that this condition is correct (this element modifies the meaning of other elements)"><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 href="valueset-condition-certainty.html" style="color: navy">Degree of confidence</a></span><span style="color: Gray"> --></span></certainty> <<a class="dict" href="condition-definitions.html#Condition.severity" title="A subjective assessment of the severity of the condition as evaluated by the clinician."><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 href="valueset-condition-severity.html" style="color: navy">Subjective severity of condition</a></span><span style="color: Gray"> --></span></severity> <<a class="dict" href="condition-definitions.html#Condition.onset_x_" title="Estimated or actual date the condition began, in the opinion of the clinician."><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]> <<a class="dict" href="condition-definitions.html#Condition.abatement_x_" 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."><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]> <<a class="dict" href="condition-definitions.html#Condition.stage" title="Clinical stage or grade of a condition. May include formal severity assessments."><b>stage</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..1</b></span> Stage/grade, usually assessed formally --></span> <<a class="dict" href="condition-definitions.html#Condition.stage.summary" title="A simple summary of the stage such as "Stage 3". The determination of the stage is disease-specific."><b>summary</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: Stage SHALL have summary or assessment"><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> <<a class="dict" href="condition-definitions.html#Condition.stage.assessment" title="Reference to a formal record of the evidence on which the staging assessment is based."><b>assessment</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: Stage SHALL have summary or assessment"><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> </stage> <<a class="dict" href="condition-definitions.html#Condition.evidence" title="Supporting Evidence / manifestations that are the basis on which this condition is suspected or confirmed."><b>evidence</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Supporting evidence --></span> <<a class="dict" href="condition-definitions.html#Condition.evidence.code" title="A manifestation or symptom that led to the recording of this condition."><b>code</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-2: evidence SHALL have code or details"><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> <<a class="dict" href="condition-definitions.html#Condition.evidence.detail" title="Links to other relevant information, including pathology reports."><b>detail</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-2: evidence SHALL have code or details"><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> </evidence> <<a class="dict" href="condition-definitions.html#Condition.location" title="The anatomical location where this condition manifests itself."><b>location</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Anatomical location, if relevant --></span> <<a class="dict" href="condition-definitions.html#Condition.location.code" title="Code that identifies the structural location."><b>code</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-3: location SHALL have code or details"><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> <<a class="dict" href="condition-definitions.html#Condition.location.detail" title="Detailed anatomical location information."><b>detail</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-3: location SHALL have code or details"><b><img alt="??" src="lock.png"/> 0..1</b></span> <span style="color: navy">Precise location details</span><span style="color: Gray"> --></span> </location> <<a class="dict" href="condition-definitions.html#Condition.relatedItem" 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."><b>relatedItem</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Causes or precedents for this Condition --></span> <<a class="dict" href="condition-definitions.html#Condition.relatedItem.type" title="The type of relationship that this condition has to the related item."><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 href="condition-relationship-type.html" style="color: navy">due-to | following</a></span><span style="color: Gray"> --></span> <<a class="dict" href="condition-definitions.html#Condition.relatedItem.code" title="Code that identifies the target of this relationship. The code takes the place of a detailed instance target."><b>code</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-4: Relationship SHALL have either a code or a target"><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 href="valueset-condition-code.html" style="color: navy">Relationship target by means of a predefined code</a></span><span style="color: Gray"> --></span></code> <<a class="dict" href="condition-definitions.html#Condition.relatedItem.target" title="Target of the relationship."><b>target</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-4: Relationship SHALL have either a code or a target"><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>| <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> </relatedItem> <<a class="dict" href="condition-definitions.html#Condition.notes" title="Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis."><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> </Condition> </pre></div> </summary> </entry> <entry> <title>"conformance" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/conformance</id> <link href="http://hl7.org/implement/standards/fhir/conformance.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="conformance-definitions.html#Conformance" 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."><b>Conformance</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="conformance-definitions.html#Conformance.identifier" 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)."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.version" 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."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.name" title="A free text natural language name identifying the conformance statement."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.publisher" title="Name of Organization publishing this conformance statement."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.telecom" title="Contacts for Organization relevant to this conformance statement. The contacts may be a website, email, phone numbers, etc."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></telecom> <<a class="dict" href="conformance-definitions.html#Conformance.description" 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."><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" title="Inv-2: A Conformance statement SHALL have at least one of description, software, or implementation"><b><img alt="??" src="lock.png"/> 0..1</b></span> <span style="color: navy">Human description of the conformance statement<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.status" title="The status of this conformance statement (this element modifies the meaning of other elements)"><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 href="conformance-statement-status.html" style="color: navy">draft | active | retired<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.experimental" 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."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.date" title="The date when the conformance statement was published."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.software" 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."><b>software</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-2: A Conformance statement SHALL have at least one of description, software, or implementation"><b><img alt="??" src="lock.png"/> 0..1</b></span> Software that is covered by this conformance statement<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.software.name" title="Name software is known by."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.software.version" title="The version identifier for the software covered by this statement."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.software.releaseDate" title="Date this version of the software released."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> </software> <<a class="dict" href="conformance-definitions.html#Conformance.implementation" 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."><b>implementation</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-2: A Conformance statement SHALL have at least one of description, software, or implementation"><b><img alt="??" src="lock.png"/> 0..1</b></span> If this describes a specific instance<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.implementation.description" title="Information about the specific installation that this conformance statement relates to."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.implementation.url" title="A base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> </implementation> <<a class="dict" href="conformance-definitions.html#Conformance.fhirVersion" title="The version of the FHIR specification on which this conformance statement is based."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.acceptUnknown" title="A flag that indicates whether the application accepts unknown elements as part of a resource."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.format" title="A list of the formats supported by this implementation."><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 href="http://www.rfc-editor.org/bcp/bcp13.txt.html" style="color: navy">formats supported (xml | json | mime type)</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.profile" 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."><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> <<a class="dict" href="conformance-definitions.html#Conformance.rest" title="A definition of the restful capabilities of the solution, if any."><b>rest</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-1: A Conformance statement SHALL have at least one of rest, messaging or document"><b><img alt="??" src="lock.png"/> 0..*</b></span> If the endpoint is a RESTful one --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.mode" title="Identifies whether this portion of the statement is describing ability to initiate or receive restful operations."><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 href="restful-conformance-mode.html" style="color: navy">client | server</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.documentation" title="Information about the system's restful capabilities that apply across all applications, such as security."><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> <<a class="dict" href="conformance-definitions.html#Conformance.rest.security" title="Information about security of implementation."><b>security</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..1</b></span> Information about security of implementation --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.security.cors" title="Server adds CORS headers when responding to requests - this enables javascript applications to yuse the server."><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> <<a class="dict" href="conformance-definitions.html#Conformance.rest.security.service" title="Types of security services are supported/required by the system."><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 href="restful-security-service.html" style="color: navy">OAuth | OAuth2 | NTLM | Basic | Kerberos</a></span><span style="color: Gray"> --></span></service> <<a class="dict" href="conformance-definitions.html#Conformance.rest.security.description" title="General description of how security works."><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> <<a class="dict" href="conformance-definitions.html#Conformance.rest.security.certificate" title="Certificates associated with security profiles."><b>certificate</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Certificates associated with security profiles --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.security.certificate.type" title="Mime type for certificate."><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 href="http://www.rfc-editor.org/bcp/bcp13.txt.html" style="color: navy">Mime type for certificate</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.security.certificate.blob" title="Actual certificate."><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> </certificate> </security> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource" title="A specification of the restful capabilities of the solution for a specific resource type."><b>resource</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>1..*</b></span> Resource served on the REST interface --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.type" title="A type of resource exposed via the restful interface."><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 href="resource-types.html" style="color: navy">A resource type that is supported</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.profile" 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."><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> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.operation" title="Identifies a restful operation supported by the solution."><b>operation</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>1..*</b></span> What operations are supported? --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.operation.code" title="Coded identifier of the operation, supported by the system resource."><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 href="type-restful-operation.html" style="color: navy">read | vread | update | delete | history-instance | validate | history-type | create | search-type</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.operation.documentation" 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'."><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> </operation> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.readHistory" title="A flag for whether the server is able to return past versions as part of the vRead operation."><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> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.updateCreate" 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."><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> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.searchInclude" title="A list of _include values supported by the server."><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> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.searchParam" title="Additional search parameters for implementations to support and/or make use of."><b>searchParam</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Additional search params defined --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.searchParam.name" title="The name of the search parameter used in the interface."><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> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.searchParam.definition" 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."><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> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.searchParam.type" title="The type of value a search parameter refers to, and how the content is interpreted."><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 href="search-param-type.html" style="color: navy">number | date | string | token | reference | composite | quantity</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.searchParam.documentation" title="This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms."><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> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.searchParam.target" title="Types of resource (if a resource is referenced)."><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 href="resource-types.html" style="color: navy">Types of resource (if a resource reference)</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.searchParam.chain" title="Chained names supported."><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> </searchParam> </resource> <<a class="dict" href="conformance-definitions.html#Conformance.rest.operation" title="A specification of restful operations supported by the system."><b>operation</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> What operations are supported? --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.operation.code" title="A coded identifier of the operation, supported by the system."><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 href="system-restful-operation.html" style="color: navy">transaction | search-system | history-system</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.operation.documentation" 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."><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> </operation> <<a class="dict" href="conformance-definitions.html#Conformance.rest.query" title="Definition of a named query and its parameters and their meaning."><b>query</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Definition of a named query --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.query.name" title="The name of a query, which is used in the _query parameter when the query is called."><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> <<a class="dict" href="conformance-definitions.html#Conformance.rest.query.definition" title="Identifies the custom query, defined either in FHIR core or another profile."><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> <<a class="dict" href="conformance-definitions.html#Conformance.rest.query.documentation" title="Additional information about how the query functions in this particular implementation."><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> <<a class="dict" href="conformance-definitions.html#Conformance.rest.query.parameter" title="Identifies which of the parameters for the named query are supported."><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> </query> <<a class="dict" href="conformance-definitions.html#Conformance.rest.documentMailbox" 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."><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> </rest> <<a class="dict" href="conformance-definitions.html#Conformance.messaging" title="A description of the messaging capabilities of the solution."><b>messaging</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-1: A Conformance statement SHALL have at least one of rest, messaging or document"><b><img alt="??" src="lock.png"/> 0..*</b></span> If messaging is supported --></span> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.endpoint" title="An address to which messages and/or replies are to be sent."><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" title="Inv-3: Messaging end point is required (and is only permitted) when statement is for an implementation"><b><img alt="??" src="lock.png"/> 0..1</b></span> <span style="color: navy">Actual endpoint being described</span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.reliableCache" 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)."><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> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.documentation" 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."><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> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.event" title="A description of the solution's support for an event at this end point."><b>event</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>1..*</b></span> Declare support for this event --></span> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.event.code" title="A coded identifier of a supported messaging event."><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 href="message-events.html" style="color: navy">Event type</a></span><span style="color: Gray"> --></span></code> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.event.category" title="The impact of the content of the message."><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 href="message-significance-category.html" style="color: navy">Consequence | Currency | Notification</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.event.mode" title="The mode of this event declaration - whether application is sender or receiver."><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 href="message-conformance-event-mode.html" style="color: navy">sender | receiver</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.event.protocol" title="A list of the messaging transport protocol(s) identifiers, supported by this endpoint."><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 href="message-transport.html" style="color: navy">http | ftp | mllp +</a></span><span style="color: Gray"> --></span></protocol> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.event.focus" title="A resource associated with the event. This is the resource that defines the event."><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 href="resource-types.html" style="color: navy">Resource that's focus of message</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.event.request" title="Information about the request for this event."><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> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.event.response" title="Information about the response for this event."><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> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.event.documentation" title="Guidance on how this event is handled, such as internal system trigger points, business rules, etc."><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> </event> </messaging> <<a class="dict" href="conformance-definitions.html#Conformance.document" title="A document definition."><b>document</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-1: A Conformance statement SHALL have at least one of rest, messaging or document"><b><img alt="??" src="lock.png"/> 0..*</b></span> Document definition --></span> <<a class="dict" href="conformance-definitions.html#Conformance.document.mode" title="Mode of this document declaration - whether application is producer or consumer."><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 href="document-mode.html" style="color: navy">producer | consumer</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.document.documentation" 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."><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> <<a class="dict" href="conformance-definitions.html#Conformance.document.profile" title="A constraint on a resource used in the document."><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> </document> </Conformance> </pre></div> </text> <name value="conformance"/> <publisher value="FHIR Project"/> <description value="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 value="draft"/> <date value="2014-09-30"/> <requirements value="Scope and Usage Conformance statements are used in one of three ways: Describe 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. This 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. A conformance statement is identified as being an implementation statement through the presence of the implementation element. Describe 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. This 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. A conformance statement is identified as being a software solution statement through the presence of the software element. Describe 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. A conformance statement is identified as being a requirements statement through the presence of the proposal element. These 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 value="Conformance"/> <publish value="true"/> <element> <path value="Conformance"/> <definition> <short value="A conformance statement"/> <formal value="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 value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <constraint> <key value="2"/> <name value="Details"/> <severity value="error"/> <human value="A Conformance statement SHALL have at least one of description, software, or implementation"/> <xpath value="count(f:software | f:implementation | f:description) > 0"/> </constraint> <constraint> <key value="1"/> <name value="Content Required"/> <severity value="error"/> <human value="A Conformance statement SHALL have at least one of rest, messaging or document"/> <xpath value="exists(f:rest) or exists(f:messaging) or exists(f:document)"/> </constraint> <constraint> <key value="7"/> <name value="Document unique"/> <severity value="error"/> <human value="The set of documents must be unique by the combination of profile & mode"/> <xpath value="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))"/> </constraint> <constraint> <key value="5"/> <name value="Messaging endpoints unique"/> <severity value="error"/> <human value="The set of end points listed for messaging must be unique"/> <xpath value="count(f:messaging/f:endpoint)=count(distinct-values(f:messaging/f:endpoint/@value))"/> </constraint> <constraint> <key value="4"/> <name value="End point populated when multiple"/> <severity value="error"/> <human value="If there is more than one messaging element, endpoint must be specified for each one"/> <xpath value="count(f:messaging)<=1 or not(f:messaging[not(f:endpoint)])"/> </constraint> <constraint> <key value="8"/> <name value="Rest unique by mode"/> <severity value="error"/> <human value="There can only be one REST declaration per mode"/> <xpath value="count(f:rest)=count(distinct-values(f:rest/f:mode/@value))"/> </constraint> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.identifier"/> <definition> <short value="Logical id to reference this statement"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.version"/> <definition> <short value="Logical id for this version of the statement"/> <formal value="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 value="There may be multiple different instances of a conformance statement that have the same identifier but different versions."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.name"/> <definition> <short value="Informal name for this conformance statement"/> <formal value="A free text natural language name identifying the conformance statement."/> <comments value="The name is not expected to be globally unique."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.publisher"/> <definition> <short value="Publishing Organization"/> <formal value="Name of Organization publishing this conformance statement."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.telecom"/> <definition> <short value="Contacts for Organization"/> <formal value="Contacts for Organization relevant to this conformance statement. The contacts may be a website, email, phone numbers, etc."/> <min value="0"/> <max value="*"/> <type> <code value="Contact"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.description"/> <definition> <short value="Human description of the conformance statement"/> <formal value="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 value="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 value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.status"/> <definition> <short value="draft | active | retired"/> <formal value="The status of this conformance statement."/> <comments value="This is not intended for use with actual conformance statements, but where conformance statements are used to describe possible or desired systems."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="ConformanceStatementStatus"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/conformance-statement-status"/> </referenceResource> </binding> </definition> </element> <element> <path value="Conformance.experimental"/> <definition> <short value="If for testing purposes, not real usage"/> <formal value="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 value="Allows filtering of conformance statements that are appropriate for use vs. not."/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.date"/> <definition> <short value="Publication Date"/> <formal value="The date when the conformance statement was published."/> <min value="1"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.software"/> <definition> <short value="Software that is covered by this conformance statement"/> <formal value="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 value="0"/> <max value="1"/> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.software.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.software.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.software.name"/> <definition> <short value="A name the software is known by"/> <formal value="Name software is known by."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.software.version"/> <definition> <short value="Version covered by this statement"/> <formal value="The version identifier for the software covered by this statement."/> <comments value="If possible, version should be specified, as statements are likely to be different for different versions of software."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.software.releaseDate"/> <definition> <short value="Date this version released"/> <formal value="Date this version of the software released."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.implementation"/> <definition> <short value="If this describes a specific instance"/> <formal value="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 value="0"/> <max value="1"/> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.implementation.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.implementation.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.implementation.description"/> <definition> <short value="Describes this specific instance"/> <formal value="Information about the specific installation that this conformance statement relates to."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.implementation.url"/> <definition> <short value="Base URL for the installation"/> <formal value="A base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces."/> <min value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.fhirVersion"/> <definition> <short value="FHIR Version"/> <formal value="The version of the FHIR specification on which this conformance statement is based."/> <min value="1"/> <max value="1"/> <type> <code value="id"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.acceptUnknown"/> <definition> <short value="True if application accepts unknown elements"/> <formal value="A flag that indicates whether the application accepts unknown elements as part of a resource."/> <comments value="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 value="1"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.format"/> <definition> <short value="formats supported (xml | json | mime type)"/> <formal value="A list of the formats supported by this implementation."/> <comments value=""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 value="1"/> <max value="*"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="MimeType"/> <isExtensible value="false"/> <conformance value="required"/> <referenceUri value="http://www.rfc-editor.org/bcp/bcp13.txt"/> </binding> </definition> </element> <element> <path value="Conformance.profile"/> <definition> <short value="Profiles supported by the system"/> <formal value="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 value="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). Typical 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 value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Profile"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest"/> <definition> <short value="If the endpoint is a RESTful one"/> <formal value="A definition of the restful capabilities of the solution, if any."/> <comments value="Multiple repetitions allow definition of both client and / or server behaviors or possibly behaviors under different configuration settings (for software or requirements statements)."/> <min value="0"/> <max value="*"/> <constraint> <key value="10"/> <name value="Query unique in rest mode"/> <severity value="error"/> <human value="A given query can only be described once per RESTful mode"/> <xpath value="count(f:query)=count(distinct-values(f:query/f:name/@value))"/> </constraint> <constraint> <key value="9"/> <name value="Resource unique in rest mode"/> <severity value="error"/> <human value="A given resource can only be described once per RESTful mode"/> <xpath value="count(f:resource)=count(distinct-values(f:resource/f:type/@value))"/> </constraint> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.mode"/> <definition> <short value="client | server"/> <formal value="Identifies whether this portion of the statement is describing ability to initiate or receive restful operations."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="RestfulConformanceMode"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/restful-conformance-mode"/> </referenceResource> </binding> </definition> </element> <element> <path value="Conformance.rest.documentation"/> <definition> <short value="General description of implementation"/> <formal value="Information about the system's restful capabilities that apply across all applications, such as security."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.security"/> <definition> <short value="Information about security of implementation"/> <formal value="Information about security of implementation."/> <min value="0"/> <max value="1"/> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.security.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.security.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.security.cors"/> <definition> <short value="Adds CORS Headers (http://enable-cors.org/)"/> <formal value="Server adds CORS headers when responding to requests - this enables javascript applications to yuse the server."/> <comments value="The easiest CORS headers to add are Access-Control-Allow-Origin: * & Access-Control-Request-Meth od: GET, POST, PUT, DELETE."/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.security.service"/> <definition> <short value="OAuth | OAuth2 | NTLM | Basic | Kerberos"/> <formal value="Types of security services are supported/required by the system."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="RestfulSecurityService"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/restful-security-service"/> </referenceResource> </binding> </definition> </element> <element> <path value="Conformance.rest.security.description"/> <definition> <short value="General description of how security works"/> <formal value="General description of how security works."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.security.certificate"/> <definition> <short value="Certificates associated with security profiles"/> <formal value="Certificates associated with security profiles."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.security.certificate.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.security.certificate.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.security.certificate.type"/> <definition> <short value="Mime type for certificate"/> <formal value="Mime type for certificate."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="MimeType"/> <isExtensible value="false"/> <conformance value="required"/> <referenceUri value="http://www.rfc-editor.org/bcp/bcp13.txt"/> </binding> </definition> </element> <element> <path value="Conformance.rest.security.certificate.blob"/> <definition> <short value="Actual certificate"/> <formal value="Actual certificate."/> <min value="0"/> <max value="1"/> <type> <code value="base64Binary"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource"/> <definition> <short value="Resource served on the REST interface"/> <formal value="A specification of the restful capabilities of the solution for a specific resource type."/> <comments value="Max of one repetition per resource type."/> <min value="1"/> <max value="*"/> <constraint> <key value="11"/> <name value="Operation unique in resource"/> <severity value="error"/> <human value="Operation codes must be unique in the context of a resource"/> <xpath value="count(f:operation)=count(distinct-values(f:operation/f:code/@value))"/> </constraint> <constraint> <key value="12"/> <name value="SearchParam unique in resource"/> <severity value="error"/> <human value="Search parameter names must be unique in the context of a resource"/> <xpath value="count(f:searchParam)=count(distinct-values(f:searchParam/f:name/@value))"/> </constraint> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource.type"/> <definition> <short value="A resource type that is supported"/> <formal value="A type of resource exposed via the restful interface."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="ResourceType"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/resource-types"/> </referenceResource> </binding> </definition> </element> <element> <path value="Conformance.rest.resource.profile"/> <definition> <short value="What structural features are supported"/> <formal value="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 value="The profile applies to all resources of this type - i.e. it is the superset of what is supported by the system."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Profile"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource.operation"/> <definition> <short value="What operations are supported?"/> <formal value="Identifies a restful operation supported by the solution."/> <min value="1"/> <max value="*"/> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource.operation.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource.operation.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource.operation.code"/> <definition> <short value="read | vread | update | delete | history-instance | validate | history-type | create | search-type"/> <formal value="Coded identifier of the operation, supported by the system resource."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="RestfulOperationType"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/type-restful-operation"/> </referenceResource> </binding> </definition> </element> <element> <path value="Conformance.rest.resource.operation.documentation"/> <definition> <short value="Anything special about operation behavior"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource.readHistory"/> <definition> <short value="Whether vRead can return past versions"/> <formal value="A flag for whether the server is able to return past versions as part of the vRead operation."/> <comments value="It is useful to support the vRead operation for current operations, even if past versions aren't available."/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource.updateCreate"/> <definition> <short value="If allows/uses update to a new location"/> <formal value="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 value="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 value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource.searchInclude"/> <definition> <short value="_include values supported by the server"/> <formal value="A list of _include values supported by the server."/> <comments value="If this list is empty, the server does not support includes."/> <min value="0"/> <max value="*"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource.searchParam"/> <definition> <short value="Additional search params defined"/> <formal value="Additional search parameters for implementations to support and/or make use of."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource.searchParam.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource.searchParam.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource.searchParam.name"/> <definition> <short value="Name of search parameter"/> <formal value="The name of the search parameter used in the interface."/> <comments value="Parameter names cannot overlap with standard parameter names, and standard parameters cannot be redefined."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource.searchParam.definition"/> <definition> <short value="Source of definition for parameter"/> <formal value="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 value="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 value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource.searchParam.type"/> <definition> <short value="number | date | string | token | reference | composite | quantity"/> <formal value="The type of value a search parameter refers to, and how the content is interpreted."/> <comments value="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 value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="SearchParamType"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/search-param-type"/> </referenceResource> </binding> </definition> </element> <element> <path value="Conformance.rest.resource.searchParam.documentation"/> <definition> <short value="Server-specific usage"/> <formal value="This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.resource.searchParam.target"/> <definition> <short value="Types of resource (if a resource reference)"/> <formal value="Types of resource (if a resource is referenced)."/> <comments value="This SHALL be the same as or a proper subset of the resources listed in the search parameter definition."/> <min value="0"/> <max value="*"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="ResourceType"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/resource-types"/> </referenceResource> </binding> </definition> </element> <element> <path value="Conformance.rest.resource.searchParam.chain"/> <definition> <short value="Chained names supported"/> <formal value="Chained names supported."/> <min value="0"/> <max value="*"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.operation"/> <definition> <short value="What operations are supported?"/> <formal value="A specification of restful operations supported by the system."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.operation.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.operation.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.operation.code"/> <definition> <short value="transaction | search-system | history-system"/> <formal value="A coded identifier of the operation, supported by the system."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="RestfulOperationSystem"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/system-restful-operation"/> </referenceResource> </binding> </definition> </element> <element> <path value="Conformance.rest.operation.documentation"/> <definition> <short value="Anything special about operation behavior"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.query"/> <definition> <short value="Definition of a named query"/> <formal value="Definition of a named query and its parameters and their meaning."/> <min value="0"/> <max value="*"/> <constraint> <key value="13"/> <name value="SearchParam unique in query"/> <severity value="error"/> <human value="Search parameter names must be unique in the context of a query"/> <xpath value="count(f:parameter)=count(distinct-values(f:parameter/f:name/@value))"/> </constraint> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.query.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.query.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.query.name"/> <definition> <short value="Special named queries (_query=)"/> <formal value="The name of a query, which is used in the _query parameter when the query is called."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.query.definition"/> <definition> <short value="Where query is defined"/> <formal value="Identifies the custom query, defined either in FHIR core or another profile."/> <min value="1"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.query.documentation"/> <definition> <short value="Additional usage guidance"/> <formal value="Additional information about how the query functions in this particular implementation."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.query.parameter"/> <definition> <short value="Parameter for the named query"/> <formal value="Identifies which of the parameters for the named query are supported."/> <comments value="This SHALL be a proper subset of the parameters defined on the query definition."/> <min value="0"/> <max value="*"/> <nameReference value="Conformance.rest.resource.searchParam"/> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.rest.documentMailbox"/> <definition> <short value="How documents are accepted in /Mailbox"/> <formal value="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 value="If a server accepts messages on the /Mailbox end-point, it declares this in the messaging elements."/> <min value="0"/> <max value="*"/> <type> <code value="uri"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.messaging"/> <definition> <short value="If messaging is supported"/> <formal value="A description of the messaging capabilities of the solution."/> <comments value="Multiple repetitions allow the documentation of multiple endpoints per solution."/> <min value="0"/> <max value="*"/> <constraint> <key value="3"/> <name value="End points for Implementations"/> <severity value="error"/> <human value="Messaging end point is required (and is only permitted) when statement is for an implementation"/> <xpath value="exists(f:endpoint) = exists(parent::f:Conformance/f:implementation)"/> </constraint> <constraint> <key value="6"/> <name value="Event unique"/> <severity value="error"/> <human value="The set of events per messaging endpoint must be unique by the combination of code & mode"/> <xpath value="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 ))"/> </constraint> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.messaging.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.messaging.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.messaging.endpoint"/> <definition> <short value="Actual endpoint being described"/> <formal value="An address to which messages and/or replies are to be sent."/> <comments value="For solutions that do not use network addresses for routing, it can be just an identifier."/> <min value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.messaging.reliableCache"/> <definition> <short value="Reliable Message Cache Length"/> <formal value="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 value="If this value is missing then the application does not implement (receiver) or depend on (sender) reliable messaging."/> <min value="0"/> <max value="1"/> <type> <code value="integer"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.messaging.documentation"/> <definition> <short value="Messaging interface behavior details"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.messaging.event"/> <definition> <short value="Declare support for this event"/> <formal value="A description of the solution's support for an event at this end point."/> <comments value="The same event may be listed up to two times - once as sender and once as receiver."/> <min value="1"/> <max value="*"/> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.messaging.event.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.messaging.event.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.messaging.event.code"/> <definition> <short value="Event type"/> <formal value="A coded identifier of a supported messaging event."/> <min value="1"/> <max value="1"/> <type> <code value="Coding"/> </type> <isModifier value="false"/> <binding> <name value="MessageEvent"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/message-events"/> </referenceResource> </binding> </definition> </element> <element> <path value="Conformance.messaging.event.category"/> <definition> <short value="Consequence | Currency | Notification"/> <formal value="The impact of the content of the message."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="MessageSignificanceCategory"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/message-significance-category"/> </referenceResource> </binding> </definition> </element> <element> <path value="Conformance.messaging.event.mode"/> <definition> <short value="sender | receiver"/> <formal value="The mode of this event declaration - whether application is sender or receiver."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="ConformanceEventMode"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/message-conformance-event-mode"/> </referenceResource> </binding> </definition> </element> <element> <path value="Conformance.messaging.event.protocol"/> <definition> <short value="http | ftp | mllp +"/> <formal value="A list of the messaging transport protocol(s) identifiers, supported by this endpoint."/> <min value="0"/> <max value="*"/> <type> <code value="Coding"/> </type> <isModifier value="false"/> <binding> <name value="MessageTransport"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/message-transport"/> </referenceResource> </binding> </definition> </element> <element> <path value="Conformance.messaging.event.focus"/> <definition> <short value="Resource that's focus of message"/> <formal value="A resource associated with the event. This is the resource that defines the event."/> <comments value="This SHALL be provided if the event type supports multiple different resource types."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="ResourceType"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/resource-types"/> </referenceResource> </binding> </definition> </element> <element> <path value="Conformance.messaging.event.request"/> <definition> <short value="Profile that describes the request"/> <formal value="Information about the request for this event."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Profile"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.messaging.event.response"/> <definition> <short value="Profile that describes the response"/> <formal value="Information about the response for this event."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Profile"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.messaging.event.documentation"/> <definition> <short value="Endpoint-specific event documentation"/> <formal value="Guidance on how this event is handled, such as internal system trigger points, business rules, etc."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.document"/> <definition> <short value="Document definition"/> <formal value="A document definition."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.document.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.document.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.document.mode"/> <definition> <short value="producer | consumer"/> <formal value="Mode of this document declaration - whether application is producer or consumer."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="DocumentMode"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/document-mode"/> </referenceResource> </binding> </definition> </element> <element> <path value="Conformance.document.documentation"/> <definition> <short value="Description of document support"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Conformance.document.profile"/> <definition> <short value="Constraint on a resource used in the document"/> <formal value="A constraint on a resource used in the document."/> <comments value="The first resource is the document resource."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Profile"/> </type> <isModifier value="false"/> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="date"/> <type value="date"/> <documentation value="The conformance statement publication date"/> <xpath value="f:Conformance/f:date"/> </searchParam> <searchParam> <name value="description"/> <type value="string"/> <documentation value="Text search in the description of the conformance statement"/> <xpath value="f:Conformance/f:description"/> </searchParam> <searchParam> <name value="event"/> <type value="token"/> <documentation value="Event code in a conformance statement"/> <xpath value="f:Conformance/f:messaging/f:event/f:code"/> </searchParam> <searchParam> <name value="fhirversion"/> <type value="token"/> <documentation value="The version of FHIR"/> <xpath value="f:Conformance/f:version"/> </searchParam> <searchParam> <name value="format"/> <type value="token"/> <documentation value="formats supported (xml | json | mime type)"/> <xpath value="f:Conformance/f:format"/> </searchParam> <searchParam> <name value="identifier"/> <type value="token"/> <documentation value="The identifier of the conformance statement"/> <xpath value="f:Conformance/f:identifier"/> </searchParam> <searchParam> <name value="mode"/> <type value="token"/> <documentation value="Mode - restful (server/client) or messaging (sender/receiver)"/> <xpath value="f:Conformance/f:rest/f:mode"/> </searchParam> <searchParam> <name value="name"/> <type value="string"/> <documentation value="Name of the conformance statement"/> <xpath value="f:Conformance/f:name"/> </searchParam> <searchParam> <name value="profile"/> <type value="reference"/> <documentation value="A profile id invoked in a conformance statement"/> <xpath value="f:Conformance/f:rest/f:resource/f:profile"/> </searchParam> <searchParam> <name value="publisher"/> <type value="string"/> <documentation value="Name of the publisher of the conformance statement"/> <xpath value="f:Conformance/f:publisher"/> </searchParam> <searchParam> <name value="resource"/> <type value="token"/> <documentation value="Name of a resource mentioned in a conformance statement"/> <xpath value="f:Conformance/f:rest/f:resource/f:type"/> </searchParam> <searchParam> <name value="security"/> <type value="token"/> <documentation value="Information about security of implementation"/> <xpath value="f:Conformance/f:rest/f:security"/> </searchParam> <searchParam> <name value="software"/> <type value="string"/> <documentation value="Part of a the name of a software application"/> <xpath value="f:Conformance/f:software/f:name"/> </searchParam> <searchParam> <name value="status"/> <type value="token"/> <documentation value="The current status of the conformance statement"/> <xpath value="f:Conformance/f:status"/> </searchParam> <searchParam> <name value="supported-profile"/> <type value="reference"/> <documentation value="Profiles supported by the system"/> <xpath value="f:Conformance/f:profile"/> </searchParam> <searchParam> <name value="version"/> <type value="token"/> <documentation value="The version identifier of the conformance statement"/> <xpath value="f:Conformance/f:version"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="conformance-definitions.html#Conformance" 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."><b>Conformance</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="conformance-definitions.html#Conformance.identifier" 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)."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.version" 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."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.name" title="A free text natural language name identifying the conformance statement."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.publisher" title="Name of Organization publishing this conformance statement."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.telecom" title="Contacts for Organization relevant to this conformance statement. The contacts may be a website, email, phone numbers, etc."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></telecom> <<a class="dict" href="conformance-definitions.html#Conformance.description" 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."><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" title="Inv-2: A Conformance statement SHALL have at least one of description, software, or implementation"><b><img alt="??" src="lock.png"/> 0..1</b></span> <span style="color: navy">Human description of the conformance statement<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.status" title="The status of this conformance statement (this element modifies the meaning of other elements)"><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 href="conformance-statement-status.html" style="color: navy">draft | active | retired<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.experimental" 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."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.date" title="The date when the conformance statement was published."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.software" 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."><b>software</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-2: A Conformance statement SHALL have at least one of description, software, or implementation"><b><img alt="??" src="lock.png"/> 0..1</b></span> Software that is covered by this conformance statement<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.software.name" title="Name software is known by."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.software.version" title="The version identifier for the software covered by this statement."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.software.releaseDate" title="Date this version of the software released."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> </software> <<a class="dict" href="conformance-definitions.html#Conformance.implementation" 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."><b>implementation</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-2: A Conformance statement SHALL have at least one of description, software, or implementation"><b><img alt="??" src="lock.png"/> 0..1</b></span> If this describes a specific instance<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.implementation.description" title="Information about the specific installation that this conformance statement relates to."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.implementation.url" title="A base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> </implementation> <<a class="dict" href="conformance-definitions.html#Conformance.fhirVersion" title="The version of the FHIR specification on which this conformance statement is based."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.acceptUnknown" title="A flag that indicates whether the application accepts unknown elements as part of a resource."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.format" title="A list of the formats supported by this implementation."><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 href="http://www.rfc-editor.org/bcp/bcp13.txt.html" style="color: navy">formats supported (xml | json | mime type)</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.profile" 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."><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> <<a class="dict" href="conformance-definitions.html#Conformance.rest" title="A definition of the restful capabilities of the solution, if any."><b>rest</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-1: A Conformance statement SHALL have at least one of rest, messaging or document"><b><img alt="??" src="lock.png"/> 0..*</b></span> If the endpoint is a RESTful one --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.mode" title="Identifies whether this portion of the statement is describing ability to initiate or receive restful operations."><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 href="restful-conformance-mode.html" style="color: navy">client | server</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.documentation" title="Information about the system's restful capabilities that apply across all applications, such as security."><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> <<a class="dict" href="conformance-definitions.html#Conformance.rest.security" title="Information about security of implementation."><b>security</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..1</b></span> Information about security of implementation --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.security.cors" title="Server adds CORS headers when responding to requests - this enables javascript applications to yuse the server."><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> <<a class="dict" href="conformance-definitions.html#Conformance.rest.security.service" title="Types of security services are supported/required by the system."><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 href="restful-security-service.html" style="color: navy">OAuth | OAuth2 | NTLM | Basic | Kerberos</a></span><span style="color: Gray"> --></span></service> <<a class="dict" href="conformance-definitions.html#Conformance.rest.security.description" title="General description of how security works."><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> <<a class="dict" href="conformance-definitions.html#Conformance.rest.security.certificate" title="Certificates associated with security profiles."><b>certificate</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Certificates associated with security profiles --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.security.certificate.type" title="Mime type for certificate."><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 href="http://www.rfc-editor.org/bcp/bcp13.txt.html" style="color: navy">Mime type for certificate</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.security.certificate.blob" title="Actual certificate."><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> </certificate> </security> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource" title="A specification of the restful capabilities of the solution for a specific resource type."><b>resource</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>1..*</b></span> Resource served on the REST interface --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.type" title="A type of resource exposed via the restful interface."><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 href="resource-types.html" style="color: navy">A resource type that is supported</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.profile" 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."><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> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.operation" title="Identifies a restful operation supported by the solution."><b>operation</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>1..*</b></span> What operations are supported? --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.operation.code" title="Coded identifier of the operation, supported by the system resource."><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 href="type-restful-operation.html" style="color: navy">read | vread | update | delete | history-instance | validate | history-type | create | search-type</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.operation.documentation" 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'."><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> </operation> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.readHistory" title="A flag for whether the server is able to return past versions as part of the vRead operation."><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> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.updateCreate" 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."><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> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.searchInclude" title="A list of _include values supported by the server."><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> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.searchParam" title="Additional search parameters for implementations to support and/or make use of."><b>searchParam</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Additional search params defined --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.searchParam.name" title="The name of the search parameter used in the interface."><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> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.searchParam.definition" 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."><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> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.searchParam.type" title="The type of value a search parameter refers to, and how the content is interpreted."><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 href="search-param-type.html" style="color: navy">number | date | string | token | reference | composite | quantity</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.searchParam.documentation" title="This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms."><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> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.searchParam.target" title="Types of resource (if a resource is referenced)."><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 href="resource-types.html" style="color: navy">Types of resource (if a resource reference)</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.resource.searchParam.chain" title="Chained names supported."><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> </searchParam> </resource> <<a class="dict" href="conformance-definitions.html#Conformance.rest.operation" title="A specification of restful operations supported by the system."><b>operation</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> What operations are supported? --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.operation.code" title="A coded identifier of the operation, supported by the system."><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 href="system-restful-operation.html" style="color: navy">transaction | search-system | history-system</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.operation.documentation" 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."><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> </operation> <<a class="dict" href="conformance-definitions.html#Conformance.rest.query" title="Definition of a named query and its parameters and their meaning."><b>query</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Definition of a named query --></span> <<a class="dict" href="conformance-definitions.html#Conformance.rest.query.name" title="The name of a query, which is used in the _query parameter when the query is called."><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> <<a class="dict" href="conformance-definitions.html#Conformance.rest.query.definition" title="Identifies the custom query, defined either in FHIR core or another profile."><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> <<a class="dict" href="conformance-definitions.html#Conformance.rest.query.documentation" title="Additional information about how the query functions in this particular implementation."><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> <<a class="dict" href="conformance-definitions.html#Conformance.rest.query.parameter" title="Identifies which of the parameters for the named query are supported."><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> </query> <<a class="dict" href="conformance-definitions.html#Conformance.rest.documentMailbox" 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."><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> </rest> <<a class="dict" href="conformance-definitions.html#Conformance.messaging" title="A description of the messaging capabilities of the solution."><b>messaging</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-1: A Conformance statement SHALL have at least one of rest, messaging or document"><b><img alt="??" src="lock.png"/> 0..*</b></span> If messaging is supported --></span> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.endpoint" title="An address to which messages and/or replies are to be sent."><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" title="Inv-3: Messaging end point is required (and is only permitted) when statement is for an implementation"><b><img alt="??" src="lock.png"/> 0..1</b></span> <span style="color: navy">Actual endpoint being described</span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.reliableCache" 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)."><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> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.documentation" 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."><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> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.event" title="A description of the solution's support for an event at this end point."><b>event</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>1..*</b></span> Declare support for this event --></span> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.event.code" title="A coded identifier of a supported messaging event."><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 href="message-events.html" style="color: navy">Event type</a></span><span style="color: Gray"> --></span></code> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.event.category" title="The impact of the content of the message."><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 href="message-significance-category.html" style="color: navy">Consequence | Currency | Notification</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.event.mode" title="The mode of this event declaration - whether application is sender or receiver."><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 href="message-conformance-event-mode.html" style="color: navy">sender | receiver</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.event.protocol" title="A list of the messaging transport protocol(s) identifiers, supported by this endpoint."><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 href="message-transport.html" style="color: navy">http | ftp | mllp +</a></span><span style="color: Gray"> --></span></protocol> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.event.focus" title="A resource associated with the event. This is the resource that defines the event."><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 href="resource-types.html" style="color: navy">Resource that's focus of message</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.event.request" title="Information about the request for this event."><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> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.event.response" title="Information about the response for this event."><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> <<a class="dict" href="conformance-definitions.html#Conformance.messaging.event.documentation" title="Guidance on how this event is handled, such as internal system trigger points, business rules, etc."><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> </event> </messaging> <<a class="dict" href="conformance-definitions.html#Conformance.document" title="A document definition."><b>document</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-1: A Conformance statement SHALL have at least one of rest, messaging or document"><b><img alt="??" src="lock.png"/> 0..*</b></span> Document definition --></span> <<a class="dict" href="conformance-definitions.html#Conformance.document.mode" title="Mode of this document declaration - whether application is producer or consumer."><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 href="document-mode.html" style="color: navy">producer | consumer</a></span><span style="color: Gray"> --></span> <<a class="dict" href="conformance-definitions.html#Conformance.document.documentation" 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."><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> <<a class="dict" href="conformance-definitions.html#Conformance.document.profile" title="A constraint on a resource used in the document."><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> </document> </Conformance> </pre></div> </summary> </entry> <entry> <title>"device" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/device</id> <link href="http://hl7.org/implement/standards/fhir/device.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="device-definitions.html#Device" 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."><b>Device</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="device-definitions.html#Device.identifier" 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."><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> <<a class="dict" href="device-definitions.html#Device.type" title="A kind of this device."><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 href="http://hit-testing.nist.gov:13110/rtmms/index.htm.html" style="color: navy">What kind of device this is</a></span><span style="color: Gray"> --></span></type> <<a class="dict" href="device-definitions.html#Device.manufacturer" title="A name of the 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> <<a class="dict" href="device-definitions.html#Device.model" 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."><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> <<a class="dict" href="device-definitions.html#Device.version" 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."><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> <<a class="dict" href="device-definitions.html#Device.expiry" title="Date of expiry of this device (if applicable)."><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> <<a class="dict" href="device-definitions.html#Device.udi" 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/UniqueDeviceIdentifica tion/default.htm."><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> <<a class="dict" href="device-definitions.html#Device.lotNumber" title="Lot number assigned by the manufacturer."><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> <<a class="dict" href="device-definitions.html#Device.owner" title="An organization that is responsible for the provision and ongoing maintenance of the device."><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> <<a class="dict" href="device-definitions.html#Device.location" 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."><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> <<a class="dict" href="device-definitions.html#Device.patient" title="Patient information, if the resource is affixed to a person."><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> <<a class="dict" href="device-definitions.html#Device.contact" title="Contact details for an organization or a particular human that is responsible for the device."><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> <<a class="dict" href="device-definitions.html#Device.url" title="A network address on which the device may be contacted directly."><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> </Device> </pre></div> </text> <name value="device"/> <publisher value="FHIR Project"/> <description value="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 value="draft"/> <date value="2014-09-30"/> <requirements value="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. Devices 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 value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <structure> <type value="Device"/> <publish value="true"/> <element> <path value="Device"/> <definition> <short value="An instance of a manufactured thing that is used in the provision of healthcare"/> <formal value="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 value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Device"/> </mapping> </definition> </element> <element> <path value="Device.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Device.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Device.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Device.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Device.identifier"/> <definition> <short value="Instance id from manufacturer, owner and others"/> <formal value="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 value="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 value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> </definition> </element> <element> <path value="Device.type"/> <definition> <short value="What kind of device this is"/> <formal value="A kind of this device."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="DeviceKind"/> <isExtensible value="true"/> <conformance value="example"/> <referenceUri value="http://hit-testing.nist.gov:13110/rtmms/index.htm"/> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> </definition> </element> <element> <path value="Device.manufacturer"/> <definition> <short value="Name of device manufacturer"/> <formal value="A name of the manufacturer."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".playedRole[typeCode=MANU].scoper.name"/> </mapping> </definition> </element> <element> <path value="Device.model"/> <definition> <short value="Model id assigned by the manufacturer"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".playedRole[typeCode=MANU].code"/> </mapping> </definition> </element> <element> <path value="Device.version"/> <definition> <short value="Version number (i.e. software)"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".softwareName (included as part)"/> </mapping> </definition> </element> <element> <path value="Device.expiry"/> <definition> <short value="Date of expiry of this device (if applicable)"/> <formal value="Date of expiry of this device (if applicable)."/> <min value="0"/> <max value="1"/> <type> <code value="date"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".expirationTime"/> </mapping> </definition> </element> <element> <path value="Device.udi"/> <definition> <short value="FDA Mandated Unique Device Identifier"/> <formal value="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/UniqueDeviceIdentifica tion/default.htm."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id[where root is root for UDI]"/> </mapping> </definition> </element> <element> <path value="Device.lotNumber"/> <definition> <short value="Lot number of manufacture"/> <formal value="Lot number assigned by the manufacturer."/> <comments value="Alphanumeric Maximum 20."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".lotNumberText"/> </mapping> </definition> </element> <element> <path value="Device.owner"/> <definition> <short value="Organization responsible for device"/> <formal value="An organization that is responsible for the provision and ongoing maintenance of the device."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Organization"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".playedRole[typeCode=OWN].scoper"/> </mapping> </definition> </element> <element> <path value="Device.location"/> <definition> <short value="Where the resource is found"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Location"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".playedRole[typeCode=LOCE].scoper"/> </mapping> </definition> </element> <element> <path value="Device.patient"/> <definition> <short value="If the resource is affixed to a person"/> <formal value="Patient information, if the resource is affixed to a person."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".playedRole[typeCode=USED].scoper.playedRole[typeCode=PAT]"/> </mapping> </definition> </element> <element> <path value="Device.contact"/> <definition> <short value="Details for human/organization for support"/> <formal value="Contact details for an organization or a particular human that is responsible for the device."/> <comments value="used for troubleshooting etc."/> <min value="0"/> <max value="*"/> <type> <code value="Contact"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".scopedRole[typeCode=CON].player"/> </mapping> </definition> </element> <element> <path value="Device.url"/> <definition> <short value="Network address to contact device"/> <formal value="A network address on which the device may be contacted directly."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".telecom"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="identifier"/> <type value="token"/> <documentation value="Instance id from manufacturer, owner and others"/> <xpath value="f:Device/f:identifier"/> </searchParam> <searchParam> <name value="location"/> <type value="reference"/> <documentation value="A location, where the resource is found"/> <xpath value="f:Device/f:location"/> </searchParam> <searchParam> <name value="manufacturer"/> <type value="string"/> <documentation value="The manufacturer of the device"/> <xpath value="f:Device/f:manufacturer"/> </searchParam> <searchParam> <name value="model"/> <type value="string"/> <documentation value="The model of the device"/> <xpath value="f:Device/f:model"/> </searchParam> <searchParam> <name value="organization"/> <type value="reference"/> <documentation value="The organization responsible for the device"/> <xpath value="f:Device/f:owner"/> </searchParam> <searchParam> <name value="patient"/> <type value="reference"/> <documentation value="Patient information, if the resource is affixed to a person"/> <xpath value="f:Device/f:patient"/> </searchParam> <searchParam> <name value="type"/> <type value="token"/> <documentation value="The type of the device"/> <xpath value="f:Device/f:type"/> </searchParam> <searchParam> <name value="udi"/> <type value="string"/> <documentation value="FDA Mandated Unique Device Identifier"/> <xpath value="f:Device/f:udi"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="device-definitions.html#Device" 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."><b>Device</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="device-definitions.html#Device.identifier" 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."><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> <<a class="dict" href="device-definitions.html#Device.type" title="A kind of this device."><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 href="http://hit-testing.nist.gov:13110/rtmms/index.htm.html" style="color: navy">What kind of device this is</a></span><span style="color: Gray"> --></span></type> <<a class="dict" href="device-definitions.html#Device.manufacturer" title="A name of the 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> <<a class="dict" href="device-definitions.html#Device.model" 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."><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> <<a class="dict" href="device-definitions.html#Device.version" 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."><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> <<a class="dict" href="device-definitions.html#Device.expiry" title="Date of expiry of this device (if applicable)."><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> <<a class="dict" href="device-definitions.html#Device.udi" 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/UniqueDeviceIdentifica tion/default.htm."><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> <<a class="dict" href="device-definitions.html#Device.lotNumber" title="Lot number assigned by the manufacturer."><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> <<a class="dict" href="device-definitions.html#Device.owner" title="An organization that is responsible for the provision and ongoing maintenance of the device."><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> <<a class="dict" href="device-definitions.html#Device.location" 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."><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> <<a class="dict" href="device-definitions.html#Device.patient" title="Patient information, if the resource is affixed to a person."><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> <<a class="dict" href="device-definitions.html#Device.contact" title="Contact details for an organization or a particular human that is responsible for the device."><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> <<a class="dict" href="device-definitions.html#Device.url" title="A network address on which the device may be contacted directly."><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> </Device> </pre></div> </summary> </entry> <entry> <title>"deviceobservationreport" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/deviceobservationreport</id> <link href="http://hl7.org/implement/standards/fhir/deviceobservationreport.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="deviceobservationreport-definitions.html#DeviceObservationReport" title="Describes the data produced by a device at a point in time."><b>DeviceObservationReport</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="deviceobservationreport-definitions.html#DeviceObservationReport.instant" title="The point in time that the values are reported."><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> <<a class="dict" href="deviceobservationreport-definitions.html#DeviceObservationReport.identifier" title="An identifier assigned to this observation bu the source device that made the observation."><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> <<a class="dict" href="deviceobservationreport-definitions.html#DeviceObservationReport.source" title="Identification information for the device that is the source of the data."><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> <<a class="dict" href="deviceobservationreport-definitions.html#DeviceObservationReport.subject" title="The subject of the measurement."><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> <<a class="dict" href="deviceobservationreport-definitions.html#DeviceObservationReport.virtualDevice" title="A medical-related subsystem of a medical device."><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> <<a class="dict" href="deviceobservationreport-definitions.html#DeviceObservationReport.virtualDevice.code" title="Describes the compartment."><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 href="http://hit-testing.nist.gov:13110/rtmms/index.htm.html" style="color: navy">Describes the compartment</a></span><span style="color: Gray"> --></span></code> <<a class="dict" href="deviceobservationreport-definitions.html#DeviceObservationReport.virtualDevice.channel" title="Groups together physiological measurement data and derived data."><b>channel</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Groups related data items --></span> <<a class="dict" href="deviceobservationreport-definitions.html#DeviceObservationReport.virtualDevice.channel.code" title="Describes the channel."><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 href="http://hit-testing.nist.gov:13110/rtmms/index.htm.html" style="color: navy">Describes the channel</a></span><span style="color: Gray"> --></span></code> <<a class="dict" href="deviceobservationreport-definitions.html#DeviceObservationReport.virtualDevice.channel.metric" title="A piece of measured or derived data that is reported by the machine."><b>metric</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Piece of data reported by device --></span> <<a class="dict" href="deviceobservationreport-definitions.html#DeviceObservationReport.virtualDevice.channel.metric.observ ation" title="The data for the metric."><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> </metric> </channel> </virtualDevice> </DeviceObservationReport> </pre></div> </text> <name value="deviceobservationreport"/> <publisher value="FHIR Project"/> <description value="Basic Profile. Describes the data produced by a device at a point in time."/> <status value="draft"/> <date value="2014-09-30"/> <requirements value="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. This resource does not cater for: * Supporting real-time analytics and in particular, alarms that might be raised as a result of such analysis * Sending commands to a device This capability is expected to be subject of additional resources that are yet to be developed, and implmenter input on this is welcome."/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <structure> <type value="DeviceObservationReport"/> <publish value="true"/> <element> <path value="DeviceObservationReport"/> <definition> <short value="Describes the data produced by a device at a point in time"/> <formal value="Describes the data produced by a device at a point in time."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Observation[classCode=OBS, moodCode=EVN, code < DeviceObservation]"/> </mapping> </definition> </element> <element> <path value="DeviceObservationReport.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DeviceObservationReport.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DeviceObservationReport.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DeviceObservationReport.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DeviceObservationReport.instant"/> <definition> <short value="When the data values are reported"/> <formal value="The point in time that the values are reported."/> <min value="1"/> <max value="1"/> <type> <code value="instant"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".effectiveTime"/> </mapping> </definition> </element> <element> <path value="DeviceObservationReport.identifier"/> <definition> <short value="As assigned by the source device"/> <formal value="An identifier assigned to this observation bu the source device that made the observation."/> <min value="0"/> <max value="1"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> </definition> </element> <element> <path value="DeviceObservationReport.source"/> <definition> <short value="Identifies/describes where the data came from"/> <formal value="Identification information for the device that is the source of the data."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Device"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=PFM].role[player.classCode=DEV]"/> </mapping> </definition> </element> <element> <path value="DeviceObservationReport.subject"/> <definition> <short value="Subject of the measurement"/> <formal value="The subject of the measurement."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Device"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Location"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=SBJ].role"/> </mapping> </definition> </element> <element> <path value="DeviceObservationReport.virtualDevice"/> <definition> <short value="A medical-related subsystem of a medical device"/> <formal value="A medical-related subsystem of a medical device."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode='COMP'].target[classCode=OBS, moodCode=EVN, code < "virtual device compartment"]"/> </mapping> </definition> </element> <element> <path value="DeviceObservationReport.virtualDevice.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DeviceObservationReport.virtualDevice.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DeviceObservationReport.virtualDevice.code"/> <definition> <short value="Describes the compartment"/> <formal value="Describes the compartment."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="VirtalDeviceKind"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceUri value="http://hit-testing.nist.gov:13110/rtmms/index.htm"/> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> </definition> </element> <element> <path value="DeviceObservationReport.virtualDevice.channel"/> <definition> <short value="Groups related data items"/> <formal value="Groups together physiological measurement data and derived data."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode='COMP'].target[classCode=OBS, moodCode=EVN, code < "channel&q uot;]"/> </mapping> </definition> </element> <element> <path value="DeviceObservationReport.virtualDevice.channel.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DeviceObservationReport.virtualDevice.channel.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DeviceObservationReport.virtualDevice.channel.code"/> <definition> <short value="Describes the channel"/> <formal value="Describes the channel."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="DeviceChannelKind1"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceUri value="http://hit-testing.nist.gov:13110/rtmms/index.htm"/> </binding> <mapping> <identity value="rim"/> <map value=".participation[typeCode=PFM].role.code"/> </mapping> </definition> </element> <element> <path value="DeviceObservationReport.virtualDevice.channel.metric"/> <definition> <short value="Piece of data reported by device"/> <formal value="A piece of measured or derived data that is reported by the machine."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> </definition> </element> <element> <path value="DeviceObservationReport.virtualDevice.channel.metric.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DeviceObservationReport.virtualDevice.channel.metric.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DeviceObservationReport.virtualDevice.channel.metric.observation"/> <definition> <short value="The data for the metric"/> <formal value="The data for the metric."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Observation"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".value"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="channel"/> <type value="token"/> <documentation value="The channel code"/> <xpath value="f:DeviceObservationReport/f:virtualDevice/f:channel/f:code"/> </searchParam> <searchParam> <name value="code"/> <type value="token"/> <documentation value="The compatment code"/> <xpath value="f:DeviceObservationReport/f:virtualDevice/f:code"/> </searchParam> <searchParam> <name value="observation"/> <type value="reference"/> <documentation value="The data for the metric"/> <xpath value="f:DeviceObservationReport/f:virtualDevice/f:channel/f:metric/f:observation"/> </searchParam> <searchParam> <name value="source"/> <type value="reference"/> <documentation value="Identifies/describes where the data came from"/> <xpath value="f:DeviceObservationReport/f:source"/> </searchParam> <searchParam> <name value="subject"/> <type value="reference"/> <documentation value="Subject of the measurement"/> <xpath value="f:DeviceObservationReport/f:subject"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="deviceobservationreport-definitions.html#DeviceObservationReport" title="Describes the data produced by a device at a point in time."><b>DeviceObservationReport</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="deviceobservationreport-definitions.html#DeviceObservationReport.instant" title="The point in time that the values are reported."><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> <<a class="dict" href="deviceobservationreport-definitions.html#DeviceObservationReport.identifier" title="An identifier assigned to this observation bu the source device that made the observation."><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> <<a class="dict" href="deviceobservationreport-definitions.html#DeviceObservationReport.source" title="Identification information for the device that is the source of the data."><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> <<a class="dict" href="deviceobservationreport-definitions.html#DeviceObservationReport.subject" title="The subject of the measurement."><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> <<a class="dict" href="deviceobservationreport-definitions.html#DeviceObservationReport.virtualDevice" title="A medical-related subsystem of a medical device."><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> <<a class="dict" href="deviceobservationreport-definitions.html#DeviceObservationReport.virtualDevice.code" title="Describes the compartment."><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 href="http://hit-testing.nist.gov:13110/rtmms/index.htm.html" style="color: navy">Describes the compartment</a></span><span style="color: Gray"> --></span></code> <<a class="dict" href="deviceobservationreport-definitions.html#DeviceObservationReport.virtualDevice.channel" title="Groups together physiological measurement data and derived data."><b>channel</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Groups related data items --></span> <<a class="dict" href="deviceobservationreport-definitions.html#DeviceObservationReport.virtualDevice.channel.code" title="Describes the channel."><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 href="http://hit-testing.nist.gov:13110/rtmms/index.htm.html" style="color: navy">Describes the channel</a></span><span style="color: Gray"> --></span></code> <<a class="dict" href="deviceobservationreport-definitions.html#DeviceObservationReport.virtualDevice.channel.metric" title="A piece of measured or derived data that is reported by the machine."><b>metric</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Piece of data reported by device --></span> <<a class="dict" href="deviceobservationreport-definitions.html#DeviceObservationReport.virtualDevice.channel.metric.observ ation" title="The data for the metric."><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> </metric> </channel> </virtualDevice> </DeviceObservationReport> </pre></div> </summary> </entry> <entry> <title>"diagnosticorder" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/diagnosticorder</id> <link href="http://hl7.org/implement/standards/fhir/diagnosticorder.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder" title="A request for a diagnostic investigation service to be performed."><b>DiagnosticOrder</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.subject" 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)."><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> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.orderer" title="The practitioner that holds legal responsibility for ordering the investigation."><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> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.identifier" title="Identifiers assigned to this order by the order or by the receiver."><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> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.encounter" title="An encounter that provides additional informaton about the healthcare context in which this request is made."><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 that this diagnostic order is associated with</span><span style="color: Gray"> --></span></encounter> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.clinicalNotes" title="An explanation or justification for why this diagnostic investigation is being requested."><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> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.specimen" title="One or more specimens that the diagnostic investigation is about."><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> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.status" title="The status of the order."><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 href="diagnostic-order-status.html" style="color: navy">requested | received | accepted | in progress | review | completed | suspended | rejected | failed</a></span><span style="color: Gray"> --></span> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.priority" title="The clinical priority associated with this order."><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 href="diagnostic-order-priority.html" style="color: navy">routine | urgent | stat | asap</a></span><span style="color: Gray"> --></span> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.event" 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."><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> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.event.status" title="The status for the event."><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 href="diagnostic-order-status.html" style="color: navy">requested | received | accepted | in progress | review | completed | suspended | rejected | failed</a></span><span style="color: Gray"> --></span> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.event.description" title="Additional information about the event that occurred - e.g. if the status remained unchanged."><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 href="valueset-diagnostic-order-event.html" style="color: navy">More information about the event and it's context</a></span><span style="color: Gray"> --></span></description> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.event.dateTime" title="The date/time at which the event occurred."><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> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.event.actor" title="The person who was responsible for performing or recording the action."><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> </event> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.item" 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."><b>item</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> The items the orderer requested --></span> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.item.code" title="A code that identifies a particular diagnostic investigation, or panel of investigations, that have been requested."><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 href="valueset-diagnostic-requests.html" style="color: navy">Code to indicate the item (test or panel) being ordered</a></span><span style="color: Gray"> --></span></code> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.item.specimen" title="If the item is related to a specific speciment."><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> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.item.bodySite" title="Anatomical location where the request test should be performed."><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 href="valueset-body-site.html" style="color: navy">Location of requested test (if applicable)</a></span><span style="color: Gray"> --></span></bodySite> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.item.status" title="The status of this individual item within the order."><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 href="diagnostic-order-status.html" style="color: navy">requested | received | accepted | in progress | review | completed | suspended | rejected | failed</a></span><span style="color: Gray"> --></span> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.item.event" title="A summary of the events of interest that have occurred as this item of the request is processed."><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> </item> </DiagnosticOrder> </pre></div> </text> <name value="diagnosticorder"/> <publisher value="FHIR Project"/> <description value="Basic Profile. A request for a diagnostic investigation service to be performed."/> <status value="draft"/> <date value="2014-09-30"/> <requirements value="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. The 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. The 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 value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <structure> <type value="DiagnosticOrder"/> <publish value="true"/> <element> <path value="DiagnosticOrder"/> <definition> <short value="A request for a diagnostic service"/> <formal value="A request for a diagnostic investigation service to be performed."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Observation[classCode=OBS, moodCode=RQO, code<"diagnostic order"]"/> </mapping> </definition> </element> <element> <path value="DiagnosticOrder.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DiagnosticOrder.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DiagnosticOrder.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DiagnosticOrder.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DiagnosticOrder.subject"/> <definition> <short value="Who and/or what test is about"/> <formal value="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 value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Group"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Location"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Device"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=SBJ].role"/> </mapping> </definition> </element> <element> <path value="DiagnosticOrder.orderer"/> <definition> <short value="Who ordered the test"/> <formal value="The practitioner that holds legal responsibility for ordering the investigation."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=AUT].role"/> </mapping> </definition> </element> <element> <path value="DiagnosticOrder.identifier"/> <definition> <short value="Identifiers assigned to this order"/> <formal value="Identifiers assigned to this order by the order or by the receiver."/> <min value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> </definition> </element> <element> <path value="DiagnosticOrder.encounter"/> <definition> <short value="The encounter that this diagnostic order is associated with"/> <formal value="An encounter that provides additional informaton about the healthcare context in which this request is made."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Encounter"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"/> </mapping> </definition> </element> <element> <path value="DiagnosticOrder.clinicalNotes"/> <definition> <short value="Explanation/Justification for test"/> <formal value="An explanation or justification for why this diagnostic investigation is being requested."/> <comments value="This may be used to decide how the diagnostic investigation will be performed, or even if it will be performed at all."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".reasonCode.originalText"/> </mapping> </definition> </element> <element> <path value="DiagnosticOrder.specimen"/> <definition> <short value="If the whole order relates to specific specimens"/> <formal value="One or more specimens that the diagnostic investigation is about."/> <comments value="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 value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Specimen"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=SPC].role"/> </mapping> </definition> </element> <element> <path value="DiagnosticOrder.status"/> <definition> <short value="requested | received | accepted | in progress | review | completed | suspended | rejected | failed"/> <formal value="The status of the order."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="DiagnosticOrderStatus"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/diagnostic-order-status"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".statusCode also 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"/> </mapping> </definition> </element> <element> <path value="DiagnosticOrder.priority"/> <definition> <short value="routine | urgent | stat | asap"/> <formal value="The clinical priority associated with this order."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="DiagnosticOrderPriority"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/diagnostic-order-priority"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".priorityCode"/> </mapping> </definition> </element> <element> <path value="DiagnosticOrder.event"/> <definition> <short value="A list of events of interest in the lifecycle"/> <formal value="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 value="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 value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=FLFS].source"/> </mapping> </definition> </element> <element> <path value="DiagnosticOrder.event.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DiagnosticOrder.event.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DiagnosticOrder.event.status"/> <definition> <short value="requested | received | accepted | in progress | review | completed | suspended | rejected | failed"/> <formal value="The status for the event."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="DiagnosticOrderStatus"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/diagnostic-order-status"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".statusCode also 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"/> </mapping> </definition> </element> <element> <path value="DiagnosticOrder.event.description"/> <definition> <short value="More information about the event and it's context"/> <formal value="Additional information about the event that occurred - e.g. if the status remained unchanged."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="DIagnosticOrderEventDescription"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/diagnostic-order-event"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".text"/> </mapping> </definition> </element> <element> <path value="DiagnosticOrder.event.dateTime"/> <definition> <short value="The date at which the event happened"/> <formal value="The date/time at which the event occurred."/> <min value="1"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".effectiveTime"/> </mapping> </definition> </element> <element> <path value="DiagnosticOrder.event.actor"/> <definition> <short value="Who recorded or did this"/> <formal value="The person who was responsible for performing or recording the action."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Device"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[AUT or PFM]"/> </mapping> </definition> </element> <element> <path value="DiagnosticOrder.item"/> <definition> <short value="The items the orderer requested"/> <formal value="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 value="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 value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=OBS]"/> </mapping> </definition> </element> <element> <path value="DiagnosticOrder.item.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DiagnosticOrder.item.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DiagnosticOrder.item.code"/> <definition> <short value="Code to indicate the item (test or panel) being ordered"/> <formal value="A code that identifies a particular diagnostic investigation, or panel of investigations, that have been requested."/> <comments value="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 value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="DiagnosticRequests"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/diagnostic-requests"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-4"/> </mapping> </definition> </element> <element> <path value="DiagnosticOrder.item.specimen"/> <definition> <short value="If this item relates to specific specimens"/> <formal value="If the item is related to a specific speciment."/> <comments value="A single specimen should not appear in both DIagnosticOrder.specimen and DiagnosticOrder.item.specim en."/> <min value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Specimen"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=SPC].role"/> </mapping> </definition> </element> <element> <path value="DiagnosticOrder.item.bodySite"/> <definition> <short value="Location of requested test (if applicable)"/> <formal value="Anatomical location where the request test should be performed."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="BodySite"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/body-site"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="targetSiteCode"/> </mapping> </definition> </element> <element> <path value="DiagnosticOrder.item.status"/> <definition> <short value="requested | received | accepted | in progress | review | completed | suspended | rejected | failed"/> <formal value="The status of this individual item within the order."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="DiagnosticOrderStatus"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/diagnostic-order-status"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".statusCode also 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"/> </mapping> </definition> </element> <element> <path value="DiagnosticOrder.item.event"/> <definition> <short value="Events specific to this item"/> <formal value="A summary of the events of interest that have occurred as this item of the request is processed."/> <min value="0"/> <max value="*"/> <nameReference value="DiagnosticOrder.event"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=FLFS].source"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="actor"/> <type value="reference"/> <documentation value="Who recorded or did this"/> </searchParam> <searchParam> <name value="bodysite"/> <type value="token"/> <documentation value="Location of requested test (if applicable)"/> <xpath value="f:DiagnosticOrder/f:item/f:bodySite"/> </searchParam> <searchParam> <name value="code"/> <type value="token"/> <documentation value="Code to indicate the item (test or panel) being ordered"/> <xpath value="f:DiagnosticOrder/f:item/f:code"/> </searchParam> <searchParam> <name value="encounter"/> <type value="reference"/> <documentation value="The encounter that this diagnostic order is associated with"/> <xpath value="f:DiagnosticOrder/f:encounter"/> </searchParam> <searchParam> <name value="event-date"/> <type value="date"/> <documentation value="The date at which the event happened"/> <xpath value="f:DiagnosticOrder/f:event/f:dateTime"/> </searchParam> <searchParam> <name value="event-status"/> <type value="token"/> <documentation value="requested | received | accepted | in progress | review | completed | suspended | rejected | failed"/> <xpath value="f:DiagnosticOrder/f:event/f:status"/> </searchParam> <searchParam> <name value="event-status-date"/> <type value="composite"/> <documentation value="A combination of past-status and date"/> </searchParam> <searchParam> <name value="identifier"/> <type value="token"/> <documentation value="Identifiers assigned to this order"/> <xpath value="f:DiagnosticOrder/f:identifier"/> </searchParam> <searchParam> <name value="item-date"/> <type value="date"/> <documentation value="The date at which the event happened"/> <xpath value="f:DiagnosticOrder/f:item/f:event/f:dateTime"/> </searchParam> <searchParam> <name value="item-past-status"/> <type value="token"/> <documentation value="requested | received | accepted | in progress | review | completed | suspended | rejected | failed"/> <xpath value="f:DiagnosticOrder/f:item/f:event/f:status"/> </searchParam> <searchParam> <name value="item-status"/> <type value="token"/> <documentation value="requested | received | accepted | in progress | review | completed | suspended | rejected | failed"/> <xpath value="f:DiagnosticOrder/f:item/f:status"/> </searchParam> <searchParam> <name value="item-status-date"/> <type value="composite"/> <documentation value="A combination of item-past-status and item-date"/> </searchParam> <searchParam> <name value="orderer"/> <type value="reference"/> <documentation value="Who ordered the test"/> <xpath value="f:DiagnosticOrder/f:orderer"/> </searchParam> <searchParam> <name value="specimen"/> <type value="reference"/> <documentation value="If the whole order relates to specific specimens"/> </searchParam> <searchParam> <name value="status"/> <type value="token"/> <documentation value="requested | received | accepted | in progress | review | completed | suspended | rejected | failed"/> <xpath value="f:DiagnosticOrder/f:status"/> </searchParam> <searchParam> <name value="subject"/> <type value="reference"/> <documentation value="Who and/or what test is about"/> <xpath value="f:DiagnosticOrder/f:subject"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder" title="A request for a diagnostic investigation service to be performed."><b>DiagnosticOrder</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.subject" 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)."><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> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.orderer" title="The practitioner that holds legal responsibility for ordering the investigation."><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> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.identifier" title="Identifiers assigned to this order by the order or by the receiver."><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> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.encounter" title="An encounter that provides additional informaton about the healthcare context in which this request is made."><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 that this diagnostic order is associated with</span><span style="color: Gray"> --></span></encounter> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.clinicalNotes" title="An explanation or justification for why this diagnostic investigation is being requested."><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> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.specimen" title="One or more specimens that the diagnostic investigation is about."><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> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.status" title="The status of the order."><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 href="diagnostic-order-status.html" style="color: navy">requested | received | accepted | in progress | review | completed | suspended | rejected | failed</a></span><span style="color: Gray"> --></span> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.priority" title="The clinical priority associated with this order."><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 href="diagnostic-order-priority.html" style="color: navy">routine | urgent | stat | asap</a></span><span style="color: Gray"> --></span> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.event" 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."><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> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.event.status" title="The status for the event."><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 href="diagnostic-order-status.html" style="color: navy">requested | received | accepted | in progress | review | completed | suspended | rejected | failed</a></span><span style="color: Gray"> --></span> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.event.description" title="Additional information about the event that occurred - e.g. if the status remained unchanged."><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 href="valueset-diagnostic-order-event.html" style="color: navy">More information about the event and it's context</a></span><span style="color: Gray"> --></span></description> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.event.dateTime" title="The date/time at which the event occurred."><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> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.event.actor" title="The person who was responsible for performing or recording the action."><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> </event> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.item" 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."><b>item</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> The items the orderer requested --></span> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.item.code" title="A code that identifies a particular diagnostic investigation, or panel of investigations, that have been requested."><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 href="valueset-diagnostic-requests.html" style="color: navy">Code to indicate the item (test or panel) being ordered</a></span><span style="color: Gray"> --></span></code> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.item.specimen" title="If the item is related to a specific speciment."><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> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.item.bodySite" title="Anatomical location where the request test should be performed."><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 href="valueset-body-site.html" style="color: navy">Location of requested test (if applicable)</a></span><span style="color: Gray"> --></span></bodySite> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.item.status" title="The status of this individual item within the order."><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 href="diagnostic-order-status.html" style="color: navy">requested | received | accepted | in progress | review | completed | suspended | rejected | failed</a></span><span style="color: Gray"> --></span> <<a class="dict" href="diagnosticorder-definitions.html#DiagnosticOrder.item.event" title="A summary of the events of interest that have occurred as this item of the request is processed."><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> </item> </DiagnosticOrder> </pre></div> </summary> </entry> <entry> <title>"diagnosticreport" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/diagnosticreport</id> <link href="http://hl7.org/implement/standards/fhir/diagnosticreport.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport" 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."><b>DiagnosticReport</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.name" title="A code or name that describes this diagnostic report."><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 href="valueset-report-names.html" style="color: navy">Name/Code for this diagnostic report</a></span><span style="color: Gray"> --></span></name> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.status" title="The status of the diagnostic report as a whole (this element modifies the meaning of other elements)"><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 href="diagnostic-report-status.html" style="color: navy">registered | partial | final | corrected +<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.issued" title="The date and/or time that this version of the report was released from the source diagnostic service."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.subject" 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."><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"> The subject of the report, usually, but not always, the patient<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></subject> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.performer" title="The diagnostic service that is responsible for issuing the report."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></performer> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.identifier" title="The local ID assigned to the report by the order filler, usually by the Information System of the diagnostic service provider."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></identifier> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.requestDetail" title="Details concerning a test requested."><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> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.serviceCategory" title="The section of the diagnostic service that performs the examination e.g. biochemistry, hematology, MRI."><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 href="valueset-diagnostic-service-sections.html" style="color: navy">Biochemistry, Hematology etc.<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></serviceCategory> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.diagnostic_x_" 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."><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"> Physiologically Relevant time/time-period for report<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></diagnostic[x]> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.specimen" title="Details about the specimens on which this Disagnostic report is based."><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> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.result" 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")."><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> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.imagingStudy" 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."><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"> Reference to full details of imaging associated with the diagnostic report</span><span style="color: Gray"> --></span></imagingStudy> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.image" 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)."><b>image</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Key images associated with this report<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span> --></span> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.image.comment" 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."><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> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.image.link" title="Reference to the image source."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></link> </image> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.conclusion" title="Concise and clinically contextualized narrative interpretation of the diagnostic report."><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> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.codedDiagnosis" title="Codes for the conclusion."><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 href="valueset-clinical-findings.html" style="color: navy">Codes for the conclusion</a></span><span style="color: Gray"> --></span></codedDiagnosis> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.presentedForm" title="Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent."><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> </DiagnosticReport> </pre></div> </text> <name value="diagnosticreport"/> <publisher value="FHIR Project"/> <description value="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 value="draft"/> <date value="2014-09-30"/> <requirements value="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. The Diagnostic Report Resource is suitable for the following kinds of Diagnostic Reports: * Laboratory (Clinical Chemistry, Hematology, Microbiology, etc.) * Pathology / Histopathology / related disciplines * Imaging Investigations (x-ray, CT, MRI etc.) * Other diagnostics - Cardiology, Gastroenterology etc. The 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 value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <structure> <type value="DiagnosticReport"/> <publish value="true"/> <element> <path value="DiagnosticReport"/> <definition> <short value="A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports"/> <formal value="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 value="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 value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Observation[classCode=OBS, moodCode=EVN]"/> </mapping> </definition> </element> <element> <path value="DiagnosticReport.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DiagnosticReport.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DiagnosticReport.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DiagnosticReport.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DiagnosticReport.name"/> <definition> <short value="Name/Code for this diagnostic report"/> <formal value="A code or name that describes this diagnostic report."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="DiagnosticReportNames"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/report-names"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="code"/> </mapping> <mapping> <identity value="v2"/> <map value="OBR-4-Universal Service ID (V2 doesn't provide an easy way to indicate both the ordered test and the performed panel)"/> </mapping> </definition> </element> <element> <path value="DiagnosticReport.status"/> <definition> <short value="registered | partial | final | corrected +"/> <formal value="The status of the diagnostic report as a whole."/> <comments value="This is labeled as "Is Modifier" because applications need to take appropriate action if a report is withdrawn."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="DiagnosticReportStatus"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/diagnostic-report-status"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="statusCode Note: final and amended are distinguished by whether observation is the subject of a ControlAct event of type "revise""/> </mapping> <mapping> <identity value="v2"/> <map value="OBR-25-Result Status (not 1:1 mapping)"/> </mapping> </definition> </element> <element> <path value="DiagnosticReport.issued"/> <definition> <short value="Date this version was released"/> <formal value="The date and/or time that this version of the report was released from the source diagnostic service."/> <comments value="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 value="1"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="participation[typeCode=VRF or AUT].time"/> </mapping> <mapping> <identity value="v2"/> <map value="OBR-22-Results Rpt/Status Chng - Date/Time"/> </mapping> </definition> </element> <element> <path value="DiagnosticReport.subject"/> <definition> <short value="The subject of the report, usually, but not always, the patient"/> <formal value="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 value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Group"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Device"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Location"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="participation[typeCode=SBJ]"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-3-Patient ID List (no V2 mapping for Group or Device)"/> </mapping> </definition> </element> <element> <path value="DiagnosticReport.performer"/> <definition> <short value="Responsible Diagnostic Service"/> <formal value="The diagnostic service that is responsible for issuing the report."/> <comments value="This is not necessarily the source of the atomic data items - it is the entity that takes responsibility for the clinical report."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Organization"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="participation[typeCode=AUT].role[classCode=ASSIGN].scoper"/> </mapping> <mapping> <identity value="v2"/> <map value="PRT-8-Participation Organization (where this PRT-4-Participation = "PO")"/> </mapping> </definition> </element> <element> <path value="DiagnosticReport.identifier"/> <definition> <short value="Id for external references to this report"/> <formal value="The local ID assigned to the report by the order filler, usually by the Information System of the diagnostic service provider."/> <min value="0"/> <max value="1"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="id"/> </mapping> <mapping> <identity value="v2"/> <map value="OBR-51-Observation Group ID (todo: check semantic intent of OBR-51 with OOWG)"/> </mapping> </definition> </element> <element> <path value="DiagnosticReport.requestDetail"/> <definition> <short value="What was requested"/> <formal value="Details concerning a test requested."/> <comments value="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 value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="outboundRelationship[typeCode=FLFS].target"/> </mapping> </definition> </element> <element> <path value="DiagnosticReport.serviceCategory"/> <definition> <short value="Biochemistry, Hematology etc."/> <formal value="The section of the diagnostic service that performs the examination e.g. biochemistry, hematology, MRI."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="DiagnosticServiceSection"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/diagnostic-service-sections"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="inboundRelationship[typeCode=COMP].source[classCode=LIST, moodCode=EVN, code < LabService].code"/> </mapping> <mapping> <identity value="v2"/> <map value="OBR-24-Diagnostic Service Section ID"/> </mapping> </definition> </element> <element> <path value="DiagnosticReport.diagnostic[x]"/> <definition> <short value="Physiologically Relevant time/time-period for report"/> <formal value="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 value="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 value="1"/> <max value="1"/> <type> <code value="dateTime"/> </type> <type> <code value="Period"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="effectiveTime"/> </mapping> <mapping> <identity value="v2"/> <map value="OBR-7-Observation Date/Time"/> </mapping> </definition> </element> <element> <path value="DiagnosticReport.specimen"/> <definition> <short value="Specimens this report is based on"/> <formal value="Details about the specimens on which this Disagnostic report is based."/> <comments value="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 value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Specimen"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="participation[typeCode=SBJ]"/> </mapping> <mapping> <identity value="v2"/> <map value="SPM"/> </mapping> </definition> </element> <element> <path value="DiagnosticReport.result"/> <definition> <short value="Observations - simple, or complex nested groups"/> <formal value="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 value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Observation"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="outboundRelationship[typeCode=COMP].target"/> </mapping> </definition> </element> <element> <path value="DiagnosticReport.imagingStudy"/> <definition> <short value="Reference to full details of imaging associated with the diagnostic report"/> <formal value="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 value="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 value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/ImagingStudy"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="outboundRelationship[typeCode=COMP].target[classsCode=DGIMG, moodCode=EVN]"/> </mapping> </definition> </element> <element> <path value="DiagnosticReport.image"/> <definition> <short value="Key images associated with this report"/> <formal value="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 value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="outboundRelationship[typeCode=COMP].target"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX?"/> </mapping> </definition> </element> <element> <path value="DiagnosticReport.image.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DiagnosticReport.image.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DiagnosticReport.image.comment"/> <definition> <short value="Comment about the image (e.g. explanation)"/> <formal value="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 value="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 value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code="annotation"] .value"/> </mapping> </definition> </element> <element> <path value="DiagnosticReport.image.link"/> <definition> <short value="Reference to the image source"/> <formal value="Reference to the image source."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Media"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".value.reference"/> </mapping> </definition> </element> <element> <path value="DiagnosticReport.conclusion"/> <definition> <short value="Clinical Interpretation of test results"/> <formal value="Concise and clinically contextualized narrative interpretation of the diagnostic report."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="inboundRelationship[typeCode="SPRT"].source[classCode=OBS, moodCode=EVN, code=LOINC:48767- 8].value (type=ST)"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX"/> </mapping> </definition> </element> <element> <path value="DiagnosticReport.codedDiagnosis"/> <definition> <short value="Codes for the conclusion"/> <formal value="Codes for the conclusion."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="AdjunctDiagnosis"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/clinical-findings"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="inboundRelationship[typeCode=SPRT].source[classCode=OBS, moodCode=EVN, code=LOINC:54531-9].value (type=CD)"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX"/> </mapping> </definition> </element> <element> <path value="DiagnosticReport.presentedForm"/> <definition> <short value="Entire Report as issued"/> <formal value="Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent."/> <comments value="Application/pdf is recommended as the most reliable and interoperable in this context."/> <min value="0"/> <max value="*"/> <type> <code value="Attachment"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="text (type=ED)"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="date"/> <type value="date"/> <documentation value="The clinically relevant time of the report"/> <xpath value="f:DiagnosticReport/f:diagnostic[x]"/> </searchParam> <searchParam> <name value="diagnosis"/> <type value="token"/> <documentation value="A coded diagnosis on the report"/> <xpath value="f:DiagnosticReport/f:codedDiagnosis"/> </searchParam> <searchParam> <name value="identifier"/> <type value="token"/> <documentation value="An identifier for the report"/> <xpath value="f:DiagnosticReport/f:identifier"/> </searchParam> <searchParam> <name value="image"/> <type value="reference"/> <documentation value="Reference to the image source"/> <xpath value="f:DiagnosticReport/f:image/f:link"/> </searchParam> <searchParam> <name value="issued"/> <type value="date"/> <documentation value="When the report was issued"/> <xpath value="f:DiagnosticReport/f:issued"/> </searchParam> <searchParam> <name value="name"/> <type value="token"/> <documentation value="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 value="f:DiagnosticReport/f:name"/> </searchParam> <searchParam> <name value="performer"/> <type value="reference"/> <documentation value="Who was the source of the report (organization)"/> <xpath value="f:DiagnosticReport/f:performer"/> </searchParam> <searchParam> <name value="request"/> <type value="reference"/> <documentation value="What was requested"/> <xpath value="f:DiagnosticReport/f:requestDetail"/> </searchParam> <searchParam> <name value="result"/> <type value="reference"/> <documentation value="Link to an atomic result (observation resource)"/> <xpath value="f:DiagnosticReport/f:result"/> </searchParam> <searchParam> <name value="service"/> <type value="token"/> <documentation value="Which diagnostic discipline/department created the report"/> <xpath value="f:DiagnosticReport/f:serviceCategory"/> </searchParam> <searchParam> <name value="specimen"/> <type value="reference"/> <documentation value="The specimen details"/> <xpath value="f:DiagnosticReport/f:specimen"/> </searchParam> <searchParam> <name value="status"/> <type value="token"/> <documentation value="The status of the report"/> <xpath value="f:DiagnosticReport/f:status"/> </searchParam> <searchParam> <name value="subject"/> <type value="reference"/> <documentation value="The subject of the report"/> <xpath value="f:DiagnosticReport/f:subject"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport" 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."><b>DiagnosticReport</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.name" title="A code or name that describes this diagnostic report."><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 href="valueset-report-names.html" style="color: navy">Name/Code for this diagnostic report</a></span><span style="color: Gray"> --></span></name> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.status" title="The status of the diagnostic report as a whole (this element modifies the meaning of other elements)"><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 href="diagnostic-report-status.html" style="color: navy">registered | partial | final | corrected +<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.issued" title="The date and/or time that this version of the report was released from the source diagnostic service."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.subject" 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."><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"> The subject of the report, usually, but not always, the patient<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></subject> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.performer" title="The diagnostic service that is responsible for issuing the report."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></performer> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.identifier" title="The local ID assigned to the report by the order filler, usually by the Information System of the diagnostic service provider."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></identifier> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.requestDetail" title="Details concerning a test requested."><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> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.serviceCategory" title="The section of the diagnostic service that performs the examination e.g. biochemistry, hematology, MRI."><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 href="valueset-diagnostic-service-sections.html" style="color: navy">Biochemistry, Hematology etc.<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></serviceCategory> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.diagnostic_x_" 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."><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"> Physiologically Relevant time/time-period for report<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></diagnostic[x]> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.specimen" title="Details about the specimens on which this Disagnostic report is based."><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> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.result" 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")."><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> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.imagingStudy" 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."><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"> Reference to full details of imaging associated with the diagnostic report</span><span style="color: Gray"> --></span></imagingStudy> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.image" 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)."><b>image</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Key images associated with this report<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span> --></span> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.image.comment" 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."><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> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.image.link" title="Reference to the image source."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></link> </image> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.conclusion" title="Concise and clinically contextualized narrative interpretation of the diagnostic report."><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> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.codedDiagnosis" title="Codes for the conclusion."><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 href="valueset-clinical-findings.html" style="color: navy">Codes for the conclusion</a></span><span style="color: Gray"> --></span></codedDiagnosis> <<a class="dict" href="diagnosticreport-definitions.html#DiagnosticReport.presentedForm" title="Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent."><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> </DiagnosticReport> </pre></div> </summary> </entry> <entry> <title>"documentmanifest" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/documentmanifest</id> <link href="http://hl7.org/implement/standards/fhir/documentmanifest.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="documentmanifest-definitions.html#DocumentManifest" title="A manifest that defines a set of documents."><b>DocumentManifest</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="documentmanifest-definitions.html#DocumentManifest.masterIdentifier" title="A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts."><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> <<a class="dict" href="documentmanifest-definitions.html#DocumentManifest.identifier" title="Other identifiers associated with the document, including version independent, source record and workflow related identifiers."><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> <<a class="dict" href="documentmanifest-definitions.html#DocumentManifest.subject" 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)."><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"> The subject of the set of documents</span><span style="color: Gray"> --></span></subject> <<a class="dict" href="documentmanifest-definitions.html#DocumentManifest.recipient" title="A patient, practitioner, or organization for which this set of documents is intended."><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"> Intended to get notified about this set of documents</span><span style="color: Gray"> --></span></recipient> <<a class="dict" href="documentmanifest-definitions.html#DocumentManifest.type" 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."><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 href="valueset-docset-codes.html" style="color: navy">What kind of document set this is</a></span><span style="color: Gray"> --></span></type> <<a class="dict" href="documentmanifest-definitions.html#DocumentManifest.author" title="Identifies who is responsible for adding the information to the document."><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"> Who and/or what authored the document</span><span style="color: Gray"> --></span></author> <<a class="dict" href="documentmanifest-definitions.html#DocumentManifest.created" 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)."><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> <<a class="dict" href="documentmanifest-definitions.html#DocumentManifest.source" title="Identifies the source system, application, or software that produced the document manifest."><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> <<a class="dict" href="documentmanifest-definitions.html#DocumentManifest.status" title="The status of this document manifest (this element modifies the meaning of other elements)"><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 href="document-reference-status.html" style="color: navy">current | superceded | entered in error</a></span><span style="color: Gray"> --></span> <<a class="dict" href="documentmanifest-definitions.html#DocumentManifest.supercedes" title="Whether this document manifest replaces another (this element modifies the meaning of other elements)"><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"> If this document manifest replaces another</span><span style="color: Gray"> --></span></supercedes> <<a class="dict" href="documentmanifest-definitions.html#DocumentManifest.description" title="Human-readable description of the source document. This is sometimes known as the "title"."><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> <<a class="dict" href="documentmanifest-definitions.html#DocumentManifest.confidentiality" title="A code specifying the level of confidentiality of this set of Documents (this element modifies the meaning of other elements)"><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 href="v3/vs/Confidentiality/index.html" style="color: navy">Sensitivity of set of documents</a><span style="color: Gray"> --></span></confidentiality> <<a class="dict" href="documentmanifest-definitions.html#DocumentManifest.content" 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."><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"> Contents of this set of documents</span><span style="color: Gray"> --></span></content> </DocumentManifest> </pre></div> </text> <name value="documentmanifest"/> <publisher value="FHIR Project"/> <description value="Basic Profile. A manifest that defines a set of documents."/> <status value="draft"/> <date value="2014-09-30"/> <requirements value="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. Typically, Document Manifest Resources are used in document indexing systems, such as IHE XDS (see the XDS specific profile)."/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <structure> <type value="DocumentManifest"/> <publish value="true"/> <element> <path value="DocumentManifest"/> <definition> <short value="A manifest that defines a set of documents"/> <formal value="A manifest that defines a set of documents."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Act[classCode=FOLDER, moodCode=EVN]"/> </mapping> </definition> </element> <element> <path value="DocumentManifest.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DocumentManifest.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DocumentManifest.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DocumentManifest.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DocumentManifest.masterIdentifier"/> <definition> <short value="Unique Identifier for the set of documents"/> <formal value="A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts."/> <min value="1"/> <max value="1"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="id [need a list semantic to indicate order matters]"/> </mapping> </definition> </element> <element> <path value="DocumentManifest.identifier"/> <definition> <short value="Other identifiers for the manifest"/> <formal value="Other identifiers associated with the document, including version independent, source record and workflow related identifiers."/> <comments value="Other identifiers can also include Identifiers may be Accession Numbers, Order Numbers, Referral Request Identifiers, XDS Workflow Instance Identifiers."/> <min value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id / .setId"/> </mapping> <mapping> <identity value="v2"/> <map value="TXA-16-Unique Document File Name?"/> </mapping> </definition> </element> <element> <path value="DocumentManifest.subject"/> <definition> <short value="The subject of the set of documents"/> <formal value="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 value="1"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Group"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Device"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=SBJ].role"/> </mapping> </definition> </element> <element> <path value="DocumentManifest.recipient"/> <definition> <short value="Intended to get notified about this set of documents"/> <formal value="A patient, practitioner, or organization for which this set of documents is intended."/> <comments value="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 value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Organization"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=IRCP].role"/> </mapping> </definition> </element> <element> <path value="DocumentManifest.type"/> <definition> <short value="What kind of document set this is"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="DocumentSetType"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/docset-codes"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> </definition> </element> <element> <path value="DocumentManifest.author"/> <definition> <short value="Who and/or what authored the document"/> <formal value="Identifies who is responsible for adding the information to the document."/> <comments value="Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant)."/> <min value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Device"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/RelatedPerson"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=AUT].role"/> </mapping> </definition> </element> <element> <path value="DocumentManifest.created"/> <definition> <short value="When this document manifest created"/> <formal value="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 value="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 value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=AUT].time"/> </mapping> </definition> </element> <element> <path value="DocumentManifest.source"/> <definition> <short value="The source system/application/software"/> <formal value="Identifies the source system, application, or software that produced the document manifest."/> <min value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=PFM].time"/> </mapping> </definition> </element> <element> <path value="DocumentManifest.status"/> <definition> <short value="current | superceded | entered in error"/> <formal value="The status of this document manifest."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="DocumentReferenceStatus"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/document-reference-status"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".statusCode"/> </mapping> </definition> </element> <element> <path value="DocumentManifest.supercedes"/> <definition> <short value="If this document manifest replaces another"/> <formal value="Whether this document manifest replaces another."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/DocumentManifest"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=RPLC].target"/> </mapping> </definition> </element> <element> <path value="DocumentManifest.description"/> <definition> <short value="Human-readable description (title)"/> <formal value="Human-readable description of the source document. This is sometimes known as the "title"."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".title"/> </mapping> </definition> </element> <element> <path value="DocumentManifest.confidentiality"/> <definition> <short value="Sensitivity of set of documents"/> <formal value="A code specifying the level of confidentiality of this set of Documents."/> <comments value="The document set is at least as confidential as the most confidential of the documents in it."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="true"/> <binding> <name value="DocumentConfidentiality"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/v3/vs/Confidentiality"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".confidentialityCode"/> </mapping> </definition> </element> <element> <path value="DocumentManifest.content"/> <definition> <short value="Contents of this set of documents"/> <formal value="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 value="1"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/DocumentReference"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Binary"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Media"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=COMP].target"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="author"/> <type value="reference"/> <documentation value="Who and/or what authored the document"/> <xpath value="f:DocumentManifest/f:author"/> </searchParam> <searchParam> <name value="confidentiality"/> <type value="token"/> <documentation value="Sensitivity of set of documents"/> <xpath value="f:DocumentManifest/f:confidentiality"/> </searchParam> <searchParam> <name value="content"/> <type value="reference"/> <documentation value="Contents of this set of documents"/> <xpath value="f:DocumentManifest/f:content"/> </searchParam> <searchParam> <name value="created"/> <type value="date"/> <documentation value="When this document manifest created"/> <xpath value="f:DocumentManifest/f:created"/> </searchParam> <searchParam> <name value="description"/> <type value="string"/> <documentation value="Human-readable description (title)"/> <xpath value="f:DocumentManifest/f:description"/> </searchParam> <searchParam> <name value="identifier"/> <type value="token"/> <documentation value="Unique Identifier for the set of documents"/> </searchParam> <searchParam> <name value="recipient"/> <type value="reference"/> <documentation value="Intended to get notified about this set of documents"/> <xpath value="f:DocumentManifest/f:recipient"/> </searchParam> <searchParam> <name value="status"/> <type value="token"/> <documentation value="current | superceded | entered in error"/> <xpath value="f:DocumentManifest/f:status"/> </searchParam> <searchParam> <name value="subject"/> <type value="reference"/> <documentation value="The subject of the set of documents"/> <xpath value="f:DocumentManifest/f:subject"/> </searchParam> <searchParam> <name value="supersedes"/> <type value="reference"/> <documentation value="If this document manifest replaces another"/> <xpath value="f:DocumentManifest/f:supercedes"/> </searchParam> <searchParam> <name value="type"/> <type value="token"/> <documentation value="What kind of document set this is"/> <xpath value="f:DocumentManifest/f:type"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="documentmanifest-definitions.html#DocumentManifest" title="A manifest that defines a set of documents."><b>DocumentManifest</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="documentmanifest-definitions.html#DocumentManifest.masterIdentifier" title="A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts."><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> <<a class="dict" href="documentmanifest-definitions.html#DocumentManifest.identifier" title="Other identifiers associated with the document, including version independent, source record and workflow related identifiers."><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> <<a class="dict" href="documentmanifest-definitions.html#DocumentManifest.subject" 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)."><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"> The subject of the set of documents</span><span style="color: Gray"> --></span></subject> <<a class="dict" href="documentmanifest-definitions.html#DocumentManifest.recipient" title="A patient, practitioner, or organization for which this set of documents is intended."><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"> Intended to get notified about this set of documents</span><span style="color: Gray"> --></span></recipient> <<a class="dict" href="documentmanifest-definitions.html#DocumentManifest.type" 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."><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 href="valueset-docset-codes.html" style="color: navy">What kind of document set this is</a></span><span style="color: Gray"> --></span></type> <<a class="dict" href="documentmanifest-definitions.html#DocumentManifest.author" title="Identifies who is responsible for adding the information to the document."><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"> Who and/or what authored the document</span><span style="color: Gray"> --></span></author> <<a class="dict" href="documentmanifest-definitions.html#DocumentManifest.created" 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)."><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> <<a class="dict" href="documentmanifest-definitions.html#DocumentManifest.source" title="Identifies the source system, application, or software that produced the document manifest."><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> <<a class="dict" href="documentmanifest-definitions.html#DocumentManifest.status" title="The status of this document manifest (this element modifies the meaning of other elements)"><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 href="document-reference-status.html" style="color: navy">current | superceded | entered in error</a></span><span style="color: Gray"> --></span> <<a class="dict" href="documentmanifest-definitions.html#DocumentManifest.supercedes" title="Whether this document manifest replaces another (this element modifies the meaning of other elements)"><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"> If this document manifest replaces another</span><span style="color: Gray"> --></span></supercedes> <<a class="dict" href="documentmanifest-definitions.html#DocumentManifest.description" title="Human-readable description of the source document. This is sometimes known as the "title"."><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> <<a class="dict" href="documentmanifest-definitions.html#DocumentManifest.confidentiality" title="A code specifying the level of confidentiality of this set of Documents (this element modifies the meaning of other elements)"><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 href="v3/vs/Confidentiality/index.html" style="color: navy">Sensitivity of set of documents</a><span style="color: Gray"> --></span></confidentiality> <<a class="dict" href="documentmanifest-definitions.html#DocumentManifest.content" 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."><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"> Contents of this set of documents</span><span style="color: Gray"> --></span></content> </DocumentManifest> </pre></div> </summary> </entry> <entry> <title>"documentreference" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/documentreference</id> <link href="http://hl7.org/implement/standards/fhir/documentreference.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="documentreference-definitions.html#DocumentReference" title="A reference to a document."><b>DocumentReference</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="documentreference-definitions.html#DocumentReference.masterIdentifier" 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."><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> <<a class="dict" href="documentreference-definitions.html#DocumentReference.identifier" title="Other identifiers associated with the document, including version independent, source record and workflow related identifiers."><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> <<a class="dict" href="documentreference-definitions.html#DocumentReference.subject" 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)."><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"> Who|what is the subject of the document</span><span style="color: Gray"> --></span></subject> <<a class="dict" href="documentreference-definitions.html#DocumentReference.type" title="Specifies the particular kind of document (e.g. Patient Summary, Discharge Summary, Prescription, etc.)."><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 href="valueset-doc-codes.html" style="color: navy">What kind of document this is (LOINC if possible)</a></span><span style="color: Gray"> --></span></type> <<a class="dict" href="documentreference-definitions.html#DocumentReference.class" title="A categorization for the type of the document. This may be implied by or derived from the code specified in the Document Type."><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 href="valueset-xds-typecodes.html" style="color: navy">Categorization of Document</a></span><span style="color: Gray"> --></span></class> <<a class="dict" href="documentreference-definitions.html#DocumentReference.author" title="Identifies who is responsible for adding the information to the document."><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"> Who and/or what authored the document</span><span style="color: Gray"> --></span></author> <<a class="dict" href="documentreference-definitions.html#DocumentReference.custodian" title="Identifies the organization or group who is responsible for ongoing maintenance of and access to the document."><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> <<a class="dict" href="documentreference-definitions.html#DocumentReference.policyManager" title="A reference to a domain or server that manages policies under which the document is accessed and/or made available."><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> <<a class="dict" href="documentreference-definitions.html#DocumentReference.authenticator" title="Which person or organization authenticates that this document is valid."><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"> Who/What authenticated the document</span><span style="color: Gray"> --></span></authenticator> <<a class="dict" href="documentreference-definitions.html#DocumentReference.created" title="When the document was 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> <<a class="dict" href="documentreference-definitions.html#DocumentReference.indexed" title="When the document reference was created."><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> <<a class="dict" href="documentreference-definitions.html#DocumentReference.status" title="The status of this document reference (this element modifies the meaning of other elements)"><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 href="document-reference-status.html" style="color: navy">current | superceded | entered in error</a></span><span style="color: Gray"> --></span> <<a class="dict" href="documentreference-definitions.html#DocumentReference.docStatus" title="The status of the underlying document."><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 href="composition-status.html" style="color: navy">preliminary | final | appended | amended | entered in error</a><span style="color: Gray"> --></span></docStatus> <<a class="dict" href="documentreference-definitions.html#DocumentReference.relatesTo" title="Relationships that this document has with other document references that already exist (this element modifies the meaning of other elements)"><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> <<a class="dict" href="documentreference-definitions.html#DocumentReference.relatesTo.code" title="The type of relationship that this document has with anther document."><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 href="document-relationship-type.html" style="color: navy">replaces | transforms | signs | appends</a></span><span style="color: Gray"> --></span> <<a class="dict" href="documentreference-definitions.html#DocumentReference.relatesTo.target" title="The target document of this relationship."><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> </relatesTo> <<a class="dict" href="documentreference-definitions.html#DocumentReference.description" title="Human-readable description of the source document. This is sometimes known as the "title"."><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> <<a class="dict" href="documentreference-definitions.html#DocumentReference.confidentiality" title="A code specifying the level of confidentiality of the XDS Document (this element modifies the meaning of other elements)"><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 href="v3/vs/Confidentiality/index.html" style="color: navy">Sensitivity of source document</a><span style="color: Gray"> --></span></confidentiality> <<a class="dict" href="documentreference-definitions.html#DocumentReference.primaryLanguage" title="The primary language in which the source document is written."><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 href="http://tools.ietf.org/html/bcp47.html" style="color: navy">The marked primary language for the document</a></span><span style="color: Gray"> --></span> <<a class="dict" href="documentreference-definitions.html#DocumentReference.mimeType" title="The mime type of the source document."><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 href="http://www.rfc-editor.org/bcp/bcp13.txt.html" style="color: navy">Mime type, + maybe character encoding</a></span><span style="color: Gray"> --></span> <<a class="dict" href="documentreference-definitions.html#DocumentReference.format" 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."><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> <<a class="dict" href="documentreference-definitions.html#DocumentReference.size" title="The size of the source document this reference refers to in bytes."><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> <<a class="dict" href="documentreference-definitions.html#DocumentReference.hash" title="A hash of the source document to ensure that changes have not occurred."><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> <<a class="dict" href="documentreference-definitions.html#DocumentReference.location" title="A url at which the document can be accessed."><b>location</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#uri">uri</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: A location or a service (or both) SHALL be provided"><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> <<a class="dict" href="documentreference-definitions.html#DocumentReference.service" title="A description of a service call that can be used to retrieve the document."><b>service</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-1: A location or a service (or both) SHALL be provided"><b><img alt="??" src="lock.png"/> 0..1</b></span> If access is not fully described by location --></span> <<a class="dict" href="documentreference-definitions.html#DocumentReference.service.type" title="The type of the service that can be used to access the documents."><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 href="valueset-documentreference-service-types.html" style="color: navy">Type of service (i.e. XDS.b)</a></span><span style="color: Gray"> --></span></type> <<a class="dict" href="documentreference-definitions.html#DocumentReference.service.address" title="Where the service end-point is located."><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> <<a class="dict" href="documentreference-definitions.html#DocumentReference.service.parameter" title="A list of named parameters that is used in the service call."><b>parameter</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Service call parameters --></span> <<a class="dict" href="documentreference-definitions.html#DocumentReference.service.parameter.name" title="The name of a parameter."><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> <<a class="dict" href="documentreference-definitions.html#DocumentReference.service.parameter.value" title="The value of the named parameter."><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> </parameter> </service> <<a class="dict" href="documentreference-definitions.html#DocumentReference.context" title="The clinical context in which the document was prepared."><b>context</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..1</b></span> Clinical context of document --></span> <<a class="dict" href="documentreference-definitions.html#DocumentReference.context.event" 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."><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 href="v3/ActCode/index.html" style="color: navy">Main Clinical Acts Documented</a><span style="color: Gray"> --></span></event> <<a class="dict" href="documentreference-definitions.html#DocumentReference.context.period" title="The time period over which the service that is described by the document was provided."><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> <<a class="dict" href="documentreference-definitions.html#DocumentReference.context.facilityType" title="The kind of facility where the patient was seen."><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 href="valueset-xds-facilitycodes.html" style="color: navy">Kind of facility where patient was seen</a></span><span style="color: Gray"> --></span></facilityType> </context> </DocumentReference> </pre></div> </text> <name value="documentreference"/> <publisher value="FHIR Project"/> <description value="Basic Profile. A reference to a document."/> <status value="draft"/> <date value="2014-09-30"/> <requirements value="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. Typically, Document Reference Resources are used in document indexing systems, such as IHE XDS (see the XDS specific profile), and are used to refer to: * CDA documents in FHIR systems * FHIR documents stored elsewhere (i.e. registry/repository following the XDS model) * PDF documents, and even digital records of faxes where sufficient information is available * Other kinds of documents, such as records of prescriptions."/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <structure> <type value="DocumentReference"/> <publish value="true"/> <element> <path value="DocumentReference"/> <definition> <short value="A reference to a document"/> <formal value="A reference to a document."/> <comments value="Usually, this is used for documents other than those defined by FHIR."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <constraint> <key value="1"/> <name value="Location"/> <severity value="error"/> <human value="A location or a service (or both) SHALL be provided"/> <xpath value="exists(f:location) or exists(f:service)"/> </constraint> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Document[classCode="DOC" and moodCode="EVN"]"/> </mapping> </definition> </element> <element> <path value="DocumentReference.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DocumentReference.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DocumentReference.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DocumentReference.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DocumentReference.masterIdentifier"/> <definition> <short value="Master Version Specific Identifier"/> <formal value="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 value="1"/> <max value="1"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> <mapping> <identity value="v2"/> <map value="TXA-12-Unique Document Number"/> </mapping> </definition> </element> <element> <path value="DocumentReference.identifier"/> <definition> <short value="Other identifiers for the document"/> <formal value="Other identifiers associated with the document, including version independent, source record and workflow related identifiers."/> <comments value="Other identifiers can also include Identifiers may be Accession Numbers, Order Numbers, Referral Request Identifiers, XDS Workflow Instance Identifiers."/> <min value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id / .setId"/> </mapping> <mapping> <identity value="v2"/> <map value="TXA-16-Unique Document File Name?"/> </mapping> </definition> </element> <element> <path value="DocumentReference.subject"/> <definition> <short value="Who|what is the subject of the document"/> <formal value="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 value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Group"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Device"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode="SBJ"].role[typeCode="PAT"]"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-3-Patient ID List (No standard way to define a Practitioner or Group subject in V2 MDM message)"/> </mapping> </definition> </element> <element> <path value="DocumentReference.type"/> <definition> <short value="What kind of document this is (LOINC if possible)"/> <formal value="Specifies the particular kind of document (e.g. Patient Summary, Discharge Summary, Prescription, etc.)."/> <comments value="Key metadata element describing the document, used in searching/filtering."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="DocumentType"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/doc-codes"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="./code"/> </mapping> <mapping> <identity value="v2"/> <map value="TXA-2-Document Type"/> </mapping> </definition> </element> <element> <path value="DocumentReference.class"/> <definition> <short value="Categorization of Document"/> <formal value="A categorization for the type of the document. This may be implied by or derived from the code specified in the Document Type."/> <comments value="Helps humans to assess whether the document is of interest when viewing an index of documents."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="DocumentClass"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/xds-typecodes"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN&quo t;].code"/> </mapping> <mapping> <identity value="v2"/> <map value=".outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN&quo t;].code"/> </mapping> </definition> </element> <element> <path value="DocumentReference.author"/> <definition> <short value="Who and/or what authored the document"/> <formal value="Identifies who is responsible for adding the information to the document."/> <comments value="Not necessarily who did the actual data entry (i.e. typist) it in or who was the source (informant)."/> <min value="1"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Device"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/RelatedPerson"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode="AUT"].role[classCode="ASSIGNED"]"/> </mapping> <mapping> <identity value="v2"/> <map value="TXA-9-Originator Code/Name (No standard way to indicate a Device in V2 MDM message)"/> </mapping> </definition> </element> <element> <path value="DocumentReference.custodian"/> <definition> <short value="Org which maintains the document"/> <formal value="Identifies the organization or group who is responsible for ongoing maintenance of and access to the document."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Organization"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode="RCV"].role[classCode="CUST"].scoper[classCode="ORG " and determinerCode="INST"]"/> </mapping> </definition> </element> <element> <path value="DocumentReference.policyManager"/> <definition> <short value="Manages access policies for the document"/> <formal value="A reference to a domain or server that manages policies under which the document is accessed and/or made available."/> <min value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="N/A - New participation type required"/> </mapping> </definition> </element> <element> <path value="DocumentReference.authenticator"/> <definition> <short value="Who/What authenticated the document"/> <formal value="Which person or organization authenticates that this document is valid."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Organization"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode="AUTHEN"].role[classCode="ASSIGNED"]"/> </mapping> <mapping> <identity value="v2"/> <map value="TXA-10-Assigned Document Authenticator"/> </mapping> </definition> </element> <element> <path value="DocumentReference.created"/> <definition> <short value="Document creation time"/> <formal value="When the document was created."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".effectiveTime[type="TS"]"/> </mapping> <mapping> <identity value="v2"/> <map value="TXA-6-Origination Date/Time"/> </mapping> </definition> </element> <element> <path value="DocumentReference.indexed"/> <definition> <short value="When this document reference created"/> <formal value="When the document reference was created."/> <comments value="Referencing/indexing time is used for tracking, organizing versions and searching."/> <min value="1"/> <max value="1"/> <type> <code value="instant"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".availabilityTime[type="TS"]"/> </mapping> </definition> </element> <element> <path value="DocumentReference.status"/> <definition> <short value="current | superceded | entered in error"/> <formal value="The status of this document reference."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="DocumentReferenceStatus"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/document-reference-status"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="interim: .completionCode="IN" & ./statusCode[isNormalDatatype()]="active"; final: .completionCode="AU" && ./statusCode[isNormalDatatype()]="complete&q uot; and not(./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[su bsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseDocum ent", code) and isNormalAct()]); amended: .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"]; withdrawn : .completionCode=NI && ./statusCode[isNo rmalDatatype()]="obsolete""/> </mapping> <mapping> <identity value="v2"/> <map value="TXA-19-Document Availability Status"/> </mapping> </definition> </element> <element> <path value="DocumentReference.docStatus"/> <definition> <short value="preliminary | final | appended | amended | entered in error"/> <formal value="The status of the underlying document."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="ReferredDocumentStatus"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/composition-status"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".statusCode"/> </mapping> <mapping> <identity value="v2"/> <map value="TXA-17-Document Completion Status"/> </mapping> </definition> </element> <element> <path value="DocumentReference.relatesTo"/> <definition> <short value="Relationships to other documents"/> <formal value="Relationships that this document has with other document references that already exist."/> <min value="0"/> <max value="*"/> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship"/> </mapping> </definition> </element> <element> <path value="DocumentReference.relatesTo.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DocumentReference.relatesTo.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DocumentReference.relatesTo.code"/> <definition> <short value="replaces | transforms | signs | appends"/> <formal value="The type of relationship that this document has with anther document."/> <comments value="If this document appends another document, then the document cannot be fully understood without also accessing the referenced document."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="DocumentRelationshipType"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/document-relationship-type"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".outboundRelationship.typeCode"/> </mapping> </definition> </element> <element> <path value="DocumentReference.relatesTo.target"/> <definition> <short value="Target of the relationship"/> <formal value="The target document of this relationship."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/DocumentReference"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".target[classCode="DOC", moodCode="EVN"].id"/> </mapping> </definition> </element> <element> <path value="DocumentReference.description"/> <definition> <short value="Human-readable description (title)"/> <formal value="Human-readable description of the source document. This is sometimes known as the "title"."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode="SUBJ"].target.text"/> </mapping> <mapping> <identity value="v2"/> <map value="TXA-25-Document Title"/> </mapping> </definition> </element> <element> <path value="DocumentReference.confidentiality"/> <definition> <short value="Sensitivity of source document"/> <formal value="A code specifying the level of confidentiality of the XDS Document."/> <comments value="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 value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="true"/> <binding> <name value="DocumentConfidentiality"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/v3/vs/Confidentiality"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".confidentialityCode"/> </mapping> <mapping> <identity value="v2"/> <map value="TXA-18-Document Confidentiality Status"/> </mapping> </definition> </element> <element> <path value="DocumentReference.primaryLanguage"/> <definition> <short value="The marked primary language for the document"/> <formal value="The primary language in which the source document is written."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="Language"/> <isExtensible value="false"/> <conformance value="required"/> <referenceUri value="http://tools.ietf.org/html/bcp47"/> </binding> <mapping> <identity value="rim"/> <map value=".languageCode"/> </mapping> </definition> </element> <element> <path value="DocumentReference.mimeType"/> <definition> <short value="Mime type, + maybe character encoding"/> <formal value="The mime type of the source document."/> <comments value="Note: application/hl7-v3+xml for CDA. application/binary for proprietary record formats."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="MimeType"/> <isExtensible value="false"/> <conformance value="required"/> <referenceUri value="http://www.rfc-editor.org/bcp/bcp13.txt"/> </binding> <mapping> <identity value="rim"/> <map value=".text.mediaType"/> </mapping> <mapping> <identity value="v2"/> <map value="TXA-3-Document Content Presentation"/> </mapping> </definition> </element> <element> <path value="DocumentReference.format"/> <definition> <short value="Format/content rules for the document"/> <formal value="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 value="Most often used when the mime-type is text/xml."/> <min value="0"/> <max value="*"/> <type> <code value="uri"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </definition> </element> <element> <path value="DocumentReference.size"/> <definition> <short value="Size of the document in bytes"/> <formal value="The size of the source document this reference refers to in bytes."/> <min value="0"/> <max value="1"/> <type> <code value="integer"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".text.length"/> </mapping> </definition> </element> <element> <path value="DocumentReference.hash"/> <definition> <short value="HexBinary representation of SHA1"/> <formal value="A hash of the source document to ensure that changes have not occurred."/> <comments value="Whether the hash must be present and/or correct depends on the document handling rules defined in the context of use."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".text.integrityCheck"/> </mapping> </definition> </element> <element> <path value="DocumentReference.location"/> <definition> <short value="Where to access the document"/> <formal value="A url at which the document can be accessed."/> <min value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".text.reference"/> </mapping> <mapping> <identity value="v2"/> <map value="(Might include V2 TXA-16-Unique Document File Name or TXA-24-Folder Assignment)"/> </mapping> </definition> </element> <element> <path value="DocumentReference.service"/> <definition> <short value="If access is not fully described by location"/> <formal value="A description of a service call that can be used to retrieve the document."/> <comments value="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 value="0"/> <max value="1"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".text.reference"/> </mapping> </definition> </element> <element> <path value="DocumentReference.service.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DocumentReference.service.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DocumentReference.service.type"/> <definition> <short value="Type of service (i.e. XDS.b)"/> <formal value="The type of the service that can be used to access the documents."/> <comments value="The meaning and interpretation of the parameters depends on the service type."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="DocumentServiceType"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/documentreference-service-types"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </definition> </element> <element> <path value="DocumentReference.service.address"/> <definition> <short value="Where service is located (usually a URL)"/> <formal value="Where the service end-point is located."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </definition> </element> <element> <path value="DocumentReference.service.parameter"/> <definition> <short value="Service call parameters"/> <formal value="A list of named parameters that is used in the service call."/> <comments value="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 value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </definition> </element> <element> <path value="DocumentReference.service.parameter.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DocumentReference.service.parameter.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DocumentReference.service.parameter.name"/> <definition> <short value="Parameter name in service call"/> <formal value="The name of a parameter."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </definition> </element> <element> <path value="DocumentReference.service.parameter.value"/> <definition> <short value="Parameter value for the name"/> <formal value="The value of the named parameter."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </definition> </element> <element> <path value="DocumentReference.context"/> <definition> <short value="Clinical context of document"/> <formal value="The clinical context in which the document was prepared."/> <comments value="These values are primarily added to help with searching for interesting/relevant documents."/> <min value="0"/> <max value="1"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="outboundRelationship[typeCode="SUBJ"].target[classCode<'ACT']"/> </mapping> </definition> </element> <element> <path value="DocumentReference.context.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DocumentReference.context.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DocumentReference.context.event"/> <definition> <short value="Main Clinical Acts Documented"/> <formal value="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 value="An event can further specialize the act inherent in the type, such as where 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 value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="DocumentEventType"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/v3/vs/ActCode"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> </definition> </element> <element> <path value="DocumentReference.context.period"/> <definition> <short value="Time of service that is being documented"/> <formal value="The time period over which the service that is described by the document was provided."/> <min value="0"/> <max value="1"/> <type> <code value="Period"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".effectiveTime"/> </mapping> </definition> </element> <element> <path value="DocumentReference.context.facilityType"/> <definition> <short value="Kind of facility where patient was seen"/> <formal value="The kind of facility where the patient was seen."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="DocumentFacilityType"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/xds-facilitycodes"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".participation[typeCode="LOC"].role[classCode="DSDLOC"].code"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="authenticator"/> <type value="reference"/> <documentation value="Who/What authenticated the document"/> <xpath value="f:DocumentReference/f:authenticator"/> </searchParam> <searchParam> <name value="author"/> <type value="reference"/> <documentation value="Who and/or what authored the document"/> <xpath value="f:DocumentReference/f:author"/> </searchParam> <searchParam> <name value="class"/> <type value="token"/> <documentation value="Categorization of Document"/> <xpath value="f:DocumentReference/f:class"/> </searchParam> <searchParam> <name value="confidentiality"/> <type value="token"/> <documentation value="Sensitivity of source document"/> <xpath value="f:DocumentReference/f:confidentiality"/> </searchParam> <searchParam> <name value="created"/> <type value="date"/> <documentation value="Document creation time"/> <xpath value="f:DocumentReference/f:created"/> </searchParam> <searchParam> <name value="custodian"/> <type value="reference"/> <documentation value="Org which maintains the document"/> <xpath value="f:DocumentReference/f:custodian"/> </searchParam> <searchParam> <name value="description"/> <type value="string"/> <documentation value="Human-readable description (title)"/> <xpath value="f:DocumentReference/f:description"/> </searchParam> <searchParam> <name value="event"/> <type value="token"/> <documentation value="Main Clinical Acts Documented"/> <xpath value="f:DocumentReference/f:context/f:event"/> </searchParam> <searchParam> <name value="facility"/> <type value="token"/> <documentation value="Kind of facility where patient was seen"/> <xpath value="f:DocumentReference/f:context/f:facilityType"/> </searchParam> <searchParam> <name value="format"/> <type value="token"/> <documentation value="Format/content rules for the document"/> <xpath value="f:DocumentReference/f:format"/> </searchParam> <searchParam> <name value="identifier"/> <type value="token"/> <documentation value="Master Version Specific Identifier"/> </searchParam> <searchParam> <name value="indexed"/> <type value="date"/> <documentation value="When this document reference created"/> <xpath value="f:DocumentReference/f:indexed"/> </searchParam> <searchParam> <name value="language"/> <type value="token"/> <documentation value="The marked primary language for the document"/> <xpath value="f:DocumentReference/f:primaryLanguage"/> </searchParam> <searchParam> <name value="location"/> <type value="string"/> <documentation value="Where to access the document"/> <xpath value="f:DocumentReference/f:location"/> </searchParam> <searchParam> <name value="period"/> <type value="date"/> <documentation value="Time of service that is being documented"/> <xpath value="f:DocumentReference/f:context/f:period"/> </searchParam> <searchParam> <name value="relatesto"/> <type value="reference"/> <documentation value="Target of the relationship"/> <xpath value="f:DocumentReference/f:relatesTo/f:target"/> </searchParam> <searchParam> <name value="relation"/> <type value="token"/> <documentation value="replaces | transforms | signs | appends"/> <xpath value="f:DocumentReference/f:relatesTo/f:code"/> </searchParam> <searchParam> <name value="relationship"/> <type value="composite"/> <documentation value="Combination of relation and relatesTo"/> </searchParam> <searchParam> <name value="size"/> <type value="number"/> <documentation value="Size of the document in bytes"/> <xpath value="f:DocumentReference/f:size"/> </searchParam> <searchParam> <name value="status"/> <type value="token"/> <documentation value="current | superceded | entered in error"/> <xpath value="f:DocumentReference/f:status"/> </searchParam> <searchParam> <name value="subject"/> <type value="reference"/> <documentation value="Who|what is the subject of the document"/> <xpath value="f:DocumentReference/f:subject"/> </searchParam> <searchParam> <name value="type"/> <type value="token"/> <documentation value="What kind of document this is (LOINC if possible)"/> <xpath value="f:DocumentReference/f:type"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="documentreference-definitions.html#DocumentReference" title="A reference to a document."><b>DocumentReference</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="documentreference-definitions.html#DocumentReference.masterIdentifier" 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."><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> <<a class="dict" href="documentreference-definitions.html#DocumentReference.identifier" title="Other identifiers associated with the document, including version independent, source record and workflow related identifiers."><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> <<a class="dict" href="documentreference-definitions.html#DocumentReference.subject" 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)."><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"> Who|what is the subject of the document</span><span style="color: Gray"> --></span></subject> <<a class="dict" href="documentreference-definitions.html#DocumentReference.type" title="Specifies the particular kind of document (e.g. Patient Summary, Discharge Summary, Prescription, etc.)."><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 href="valueset-doc-codes.html" style="color: navy">What kind of document this is (LOINC if possible)</a></span><span style="color: Gray"> --></span></type> <<a class="dict" href="documentreference-definitions.html#DocumentReference.class" title="A categorization for the type of the document. This may be implied by or derived from the code specified in the Document Type."><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 href="valueset-xds-typecodes.html" style="color: navy">Categorization of Document</a></span><span style="color: Gray"> --></span></class> <<a class="dict" href="documentreference-definitions.html#DocumentReference.author" title="Identifies who is responsible for adding the information to the document."><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"> Who and/or what authored the document</span><span style="color: Gray"> --></span></author> <<a class="dict" href="documentreference-definitions.html#DocumentReference.custodian" title="Identifies the organization or group who is responsible for ongoing maintenance of and access to the document."><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> <<a class="dict" href="documentreference-definitions.html#DocumentReference.policyManager" title="A reference to a domain or server that manages policies under which the document is accessed and/or made available."><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> <<a class="dict" href="documentreference-definitions.html#DocumentReference.authenticator" title="Which person or organization authenticates that this document is valid."><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"> Who/What authenticated the document</span><span style="color: Gray"> --></span></authenticator> <<a class="dict" href="documentreference-definitions.html#DocumentReference.created" title="When the document was 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> <<a class="dict" href="documentreference-definitions.html#DocumentReference.indexed" title="When the document reference was created."><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> <<a class="dict" href="documentreference-definitions.html#DocumentReference.status" title="The status of this document reference (this element modifies the meaning of other elements)"><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 href="document-reference-status.html" style="color: navy">current | superceded | entered in error</a></span><span style="color: Gray"> --></span> <<a class="dict" href="documentreference-definitions.html#DocumentReference.docStatus" title="The status of the underlying document."><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 href="composition-status.html" style="color: navy">preliminary | final | appended | amended | entered in error</a><span style="color: Gray"> --></span></docStatus> <<a class="dict" href="documentreference-definitions.html#DocumentReference.relatesTo" title="Relationships that this document has with other document references that already exist (this element modifies the meaning of other elements)"><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> <<a class="dict" href="documentreference-definitions.html#DocumentReference.relatesTo.code" title="The type of relationship that this document has with anther document."><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 href="document-relationship-type.html" style="color: navy">replaces | transforms | signs | appends</a></span><span style="color: Gray"> --></span> <<a class="dict" href="documentreference-definitions.html#DocumentReference.relatesTo.target" title="The target document of this relationship."><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> </relatesTo> <<a class="dict" href="documentreference-definitions.html#DocumentReference.description" title="Human-readable description of the source document. This is sometimes known as the "title"."><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> <<a class="dict" href="documentreference-definitions.html#DocumentReference.confidentiality" title="A code specifying the level of confidentiality of the XDS Document (this element modifies the meaning of other elements)"><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 href="v3/vs/Confidentiality/index.html" style="color: navy">Sensitivity of source document</a><span style="color: Gray"> --></span></confidentiality> <<a class="dict" href="documentreference-definitions.html#DocumentReference.primaryLanguage" title="The primary language in which the source document is written."><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 href="http://tools.ietf.org/html/bcp47.html" style="color: navy">The marked primary language for the document</a></span><span style="color: Gray"> --></span> <<a class="dict" href="documentreference-definitions.html#DocumentReference.mimeType" title="The mime type of the source document."><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 href="http://www.rfc-editor.org/bcp/bcp13.txt.html" style="color: navy">Mime type, + maybe character encoding</a></span><span style="color: Gray"> --></span> <<a class="dict" href="documentreference-definitions.html#DocumentReference.format" 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."><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> <<a class="dict" href="documentreference-definitions.html#DocumentReference.size" title="The size of the source document this reference refers to in bytes."><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> <<a class="dict" href="documentreference-definitions.html#DocumentReference.hash" title="A hash of the source document to ensure that changes have not occurred."><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> <<a class="dict" href="documentreference-definitions.html#DocumentReference.location" title="A url at which the document can be accessed."><b>location</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#uri">uri</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: A location or a service (or both) SHALL be provided"><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> <<a class="dict" href="documentreference-definitions.html#DocumentReference.service" title="A description of a service call that can be used to retrieve the document."><b>service</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-1: A location or a service (or both) SHALL be provided"><b><img alt="??" src="lock.png"/> 0..1</b></span> If access is not fully described by location --></span> <<a class="dict" href="documentreference-definitions.html#DocumentReference.service.type" title="The type of the service that can be used to access the documents."><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 href="valueset-documentreference-service-types.html" style="color: navy">Type of service (i.e. XDS.b)</a></span><span style="color: Gray"> --></span></type> <<a class="dict" href="documentreference-definitions.html#DocumentReference.service.address" title="Where the service end-point is located."><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> <<a class="dict" href="documentreference-definitions.html#DocumentReference.service.parameter" title="A list of named parameters that is used in the service call."><b>parameter</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Service call parameters --></span> <<a class="dict" href="documentreference-definitions.html#DocumentReference.service.parameter.name" title="The name of a parameter."><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> <<a class="dict" href="documentreference-definitions.html#DocumentReference.service.parameter.value" title="The value of the named parameter."><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> </parameter> </service> <<a class="dict" href="documentreference-definitions.html#DocumentReference.context" title="The clinical context in which the document was prepared."><b>context</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..1</b></span> Clinical context of document --></span> <<a class="dict" href="documentreference-definitions.html#DocumentReference.context.event" 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."><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 href="v3/ActCode/index.html" style="color: navy">Main Clinical Acts Documented</a><span style="color: Gray"> --></span></event> <<a class="dict" href="documentreference-definitions.html#DocumentReference.context.period" title="The time period over which the service that is described by the document was provided."><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> <<a class="dict" href="documentreference-definitions.html#DocumentReference.context.facilityType" title="The kind of facility where the patient was seen."><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 href="valueset-xds-facilitycodes.html" style="color: navy">Kind of facility where patient was seen</a></span><span style="color: Gray"> --></span></facilityType> </context> </DocumentReference> </pre></div> </summary> </entry> <entry> <title>"encounter" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/encounter</id> <link href="http://hl7.org/implement/standards/fhir/encounter.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="encounter-definitions.html#Encounter" 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."><b>Encounter</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="encounter-definitions.html#Encounter.identifier" title="Identifier(s) by which this encounter is known."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></identifier> <<a class="dict" href="encounter-definitions.html#Encounter.status" title="planned | in progress | onleave | finished | cancelled (this element modifies the meaning of other elements)"><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 href="encounter-state.html" style="color: navy">planned | in progress | onleave | finished | cancelled<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span> <<a class="dict" href="encounter-definitions.html#Encounter.class" title="inpatient | outpatient | ambulatory | emergency + (this element modifies the meaning of other elements)"><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 href="encounter-class.html" style="color: navy">inpatient | outpatient | ambulatory | emergency +<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span> <<a class="dict" href="encounter-definitions.html#Encounter.type" title="Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation)."><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 href="valueset-encounter-type.html" style="color: navy">Specific type of encounter<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></type> <<a class="dict" href="encounter-definitions.html#Encounter.subject" title="The patient present at the encounter."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></subject> <<a class="dict" href="encounter-definitions.html#Encounter.participant" title="The main practitioner responsible for providing the service."><b>participant</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> List of participants involved in the encounter<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span> --></span> <<a class="dict" href="encounter-definitions.html#Encounter.participant.type" title="Role of participant in encounter."><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 href="valueset-encounter-participant-type.html" style="color: navy">Role of participant in encounter<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></type> <<a class="dict" href="encounter-definitions.html#Encounter.participant.individual" title="Persons involved in the encounter other than the patient."><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"> Persons involved in the encounter other than the patient<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></individual> </participant> <<a class="dict" href="encounter-definitions.html#Encounter.period" title="The start and end time of the encounter."><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> <<a class="dict" href="encounter-definitions.html#Encounter.length" title="Quantity of time the encounter lasted. This excludes the time during leaves of absence."><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> <<a class="dict" href="encounter-definitions.html#Encounter.reason" title="Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis."><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 href="valueset-encounter-reason.html" style="color: navy">Reason the encounter takes place (code)<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></reason> <<a class="dict" href="encounter-definitions.html#Encounter.indication" title="Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis."><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> <<a class="dict" href="encounter-definitions.html#Encounter.priority" title="Indicates the urgency of the encounter."><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 href="valueset-encounter-priority.html" style="color: navy">Indicates the urgency of the encounter</a></span><span style="color: Gray"> --></span></priority> <<a class="dict" href="encounter-definitions.html#Encounter.hospitalization" title="Details about an admission to a clinic."><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> <<a class="dict" href="encounter-definitions.html#Encounter.hospitalization.preAdmissionIdentifier" title="Pre-admission identifier."><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> <<a class="dict" href="encounter-definitions.html#Encounter.hospitalization.origin" title="The location from which the patient came before admission."><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"> The location from which the patient came before admission</span><span style="color: Gray"> --></span></origin> <<a class="dict" href="encounter-definitions.html#Encounter.hospitalization.admitSource" title="From where patient was admitted (physician referral, transfer)."><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 href="valueset-encounter-admit-source.html" style="color: navy">From where patient was admitted (physician referral, transfer)</a></span><span style="color: Gray"> --></span></admitSource> <<a class="dict" href="encounter-definitions.html#Encounter.hospitalization.period" title="Period during which the patient was admitted."><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> <<a class="dict" href="encounter-definitions.html#Encounter.hospitalization.accomodation" title="Where the patient stays during this encounter."><b>accomodation</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Where the patient stays during this encounter --></span> <<a class="dict" href="encounter-definitions.html#Encounter.hospitalization.accomodation.bed" title="The bed that is assigned to the patient."><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> <<a class="dict" href="encounter-definitions.html#Encounter.hospitalization.accomodation.period" title="Period during which the patient was assigned the bed."><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> </accomodation> <<a class="dict" href="encounter-definitions.html#Encounter.hospitalization.diet" title="Dietary restrictions for the patient."><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 href="valueset-encounter-diet.html" style="color: navy">Dietary restrictions for the patient</a></span><span style="color: Gray"> --></span></diet> <<a class="dict" href="encounter-definitions.html#Encounter.hospitalization.specialCourtesy" title="Special courtesies (VIP, board member)."><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 href="valueset-encounter-special-courtesy.html" style="color: navy">Special courtesies (VIP, board member)</a></span><span style="color: Gray"> --></span></specialCourtesy> <<a class="dict" href="encounter-definitions.html#Encounter.hospitalization.specialArrangement" title="Wheelchair, translator, stretcher, etc."><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 href="valueset-encounter-special-arrangements.html" style="color: navy">Wheelchair, translator, stretcher, etc</a></span><span style="color: Gray"> --></span></specialArrangement> <<a class="dict" href="encounter-definitions.html#Encounter.hospitalization.destination" title="Location to which the patient is discharged."><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> <<a class="dict" href="encounter-definitions.html#Encounter.hospitalization.dischargeDisposition" title="Category or kind of location after discharge."><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 href="valueset-encounter-discharge-disposition.html" style="color: navy">Category or kind of location after discharge</a></span><span style="color: Gray"> --></span></dischargeDisposition> <<a class="dict" href="encounter-definitions.html#Encounter.hospitalization.dischargeDiagnosis" title="The final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete."><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"> 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> <<a class="dict" href="encounter-definitions.html#Encounter.hospitalization.reAdmission" title="Whether this hospitalization is a 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> </hospitalization> <<a class="dict" href="encounter-definitions.html#Encounter.location" title="List of locations at which the patient has been."><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> <<a class="dict" href="encounter-definitions.html#Encounter.location.location" title="The location where the encounter takes place."><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> <<a class="dict" href="encounter-definitions.html#Encounter.location.period" title="Time period during which the patient was present at the location."><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> </location> <<a class="dict" href="encounter-definitions.html#Encounter.serviceProvider" title="Department or team providing care."><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> <<a class="dict" href="encounter-definitions.html#Encounter.partOf" title="Another Encounter of which this encounter is a part of (administratively or in time)."><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> </Encounter> </pre></div> </text> <name value="encounter"/> <publisher value="FHIR Project"/> <description value="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 value="draft"/> <date value="2014-09-30"/> <requirements value="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. Because 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. There 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. Encounter 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 value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <structure> <type value="Encounter"/> <publish value="true"/> <element> <path value="Encounter"/> <definition> <short value="An interaction during which services are provided to the patient"/> <formal value="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 value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Encounter[moodCode=EVN]"/> </mapping> </definition> </element> <element> <path value="Encounter.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Encounter.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Encounter.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Encounter.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Encounter.identifier"/> <definition> <short value="Identifier(s) by which this encounter is known"/> <formal value="Identifier(s) by which this encounter is known."/> <min value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> <mapping> <identity value="v2"/> <map value="PV1-19-visit number"/> </mapping> </definition> </element> <element> <path value="Encounter.status"/> <definition> <short value="planned | in progress | onleave | finished | cancelled"/> <formal value="planned | in progress | onleave | finished | cancelled."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="EncounterState"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/encounter-state"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".statusCode"/> </mapping> <mapping> <identity value="v2"/> <map value="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"/> </mapping> </definition> </element> <element> <path value="Encounter.class"/> <definition> <short value="inpatient | outpatient | ambulatory | emergency +"/> <formal value="inpatient | outpatient | ambulatory | emergency +."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="EncounterClass"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/encounter-class"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=SUBJ].source[classCode=LIST].code"/> </mapping> <mapping> <identity value="v2"/> <map value="PV1-2-patient class"/> </mapping> </definition> </element> <element> <path value="Encounter.type"/> <definition> <short value="Specific type of encounter"/> <formal value="Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation)."/> <comments value="Since there are many ways to further classify encounters, this element is 0..*."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="EncounterType"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/encounter-type"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> <mapping> <identity value="v2"/> <map value="PV1-4-admission type"/> </mapping> </definition> </element> <element> <path value="Encounter.subject"/> <definition> <short value="The patient present at the encounter"/> <formal value="The patient present at the encounter."/> <comments value="While the encounter is always about the patient, the patient may not actually be known in all contexts of use."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=SBJ]/role[classCode=PAT]"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-3-patient ID list"/> </mapping> </definition> </element> <element> <path value="Encounter.participant"/> <definition> <short value="List of participants involved in the encounter"/> <formal value="The main practitioner responsible for providing the service."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=PFM]"/> </mapping> </definition> </element> <element> <path value="Encounter.participant.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Encounter.participant.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Encounter.participant.type"/> <definition> <short value="Role of participant in encounter"/> <formal value="Role of participant in encounter."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="ParticipantType"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/encounter-participant-type"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".functionCode"/> </mapping> <mapping> <identity value="v2"/> <map value="PRT-4-participation"/> </mapping> </definition> </element> <element> <path value="Encounter.participant.individual"/> <definition> <short value="Persons involved in the encounter other than the patient"/> <formal value="Persons involved in the encounter other than the patient."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/RelatedPerson"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".role"/> </mapping> <mapping> <identity value="v2"/> <map value="PRT-5-participation person"/> </mapping> </definition> </element> <element> <path value="Encounter.period"/> <definition> <short value="The start and end time of the encounter"/> <formal value="The start and end time of the encounter."/> <comments value="If not (yet) known, the end of the Period may be omitted."/> <min value="0"/> <max value="1"/> <type> <code value="Period"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".effectiveTime (low & high)"/> </mapping> </definition> </element> <element> <path value="Encounter.length"/> <definition> <short value="Quantity of time the encounter lasted"/> <formal value="Quantity of time the encounter lasted. This excludes the time during leaves of absence."/> <comments value="May differ from the time the Encounter.period lasted because of leave of absence."/> <min value="0"/> <max value="1"/> <type> <code value="Duration"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".lengthOfStayQuantity"/> </mapping> <mapping> <identity value="v2"/> <map value="(PV1-45 less PV1-44) iff ( (PV1-44 not empty) and (PV1-45 not empty) ); units in minutes"/> </mapping> </definition> </element> <element> <path value="Encounter.reason"/> <definition> <short value="Reason the encounter takes place (code)"/> <formal value="Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="EncounterReason"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/encounter-reason"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".reasonCode"/> </mapping> <mapping> <identity value="v2"/> <map value="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 )"/> </mapping> </definition> </element> <element> <path value="Encounter.indication"/> <definition> <short value="Reason the encounter takes place (resource)"/> <formal value="Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Any"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=RSON].target"/> </mapping> </definition> </element> <element> <path value="Encounter.priority"/> <definition> <short value="Indicates the urgency of the encounter"/> <formal value="Indicates the urgency of the encounter."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="Priority"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/encounter-priority"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".priorityCode"/> </mapping> <mapping> <identity value="v2"/> <map value="PV2-25-visit priority code"/> </mapping> </definition> </element> <element> <path value="Encounter.hospitalization"/> <definition> <short value="Details about an admission to a clinic"/> <formal value="Details about an admission to a clinic."/> <min value="0"/> <max value="1"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=COMP].target[classCode=ENC, moodCode=EVN]"/> </mapping> </definition> </element> <element> <path value="Encounter.hospitalization.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Encounter.hospitalization.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Encounter.hospitalization.preAdmissionIdentifier"/> <definition> <short value="Pre-admission identifier"/> <formal value="Pre-admission identifier."/> <min value="0"/> <max value="1"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> <mapping> <identity value="v2"/> <map value="PV1-5-preadmit number"/> </mapping> </definition> </element> <element> <path value="Encounter.hospitalization.origin"/> <definition> <short value="The location from which the patient came before admission"/> <formal value="The location from which the patient came before admission."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Location"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=ORG].role"/> </mapping> </definition> </element> <element> <path value="Encounter.hospitalization.admitSource"/> <definition> <short value="From where patient was admitted (physician referral, transfer)"/> <formal value="From where patient was admitted (physician referral, transfer)."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="AdmitSource"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/encounter-admit-source"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".admissionReferralSourceCode"/> </mapping> <mapping> <identity value="v2"/> <map value="PV1-14-admit source"/> </mapping> </definition> </element> <element> <path value="Encounter.hospitalization.period"/> <definition> <short value="Period during which the patient was admitted"/> <formal value="Period during which the patient was admitted."/> <comments value="May differ from start + length, since length excludes leaves of absence."/> <min value="0"/> <max value="1"/> <type> <code value="Period"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".effectiveTime"/> </mapping> <mapping> <identity value="v2"/> <map value="PV2-11-actual length of inpatient stay / PV1-44-admit date/time / PV1-45-discharge date/time"/> </mapping> </definition> </element> <element> <path value="Encounter.hospitalization.accomodation"/> <definition> <short value="Where the patient stays during this encounter"/> <formal value="Where the patient stays during this encounter."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=COMP].target[classCode=ACCOM, moodCode=EVN]"/> </mapping> </definition> </element> <element> <path value="Encounter.hospitalization.accomodation.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Encounter.hospitalization.accomodation.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Encounter.hospitalization.accomodation.bed"/> <definition> <short value="The bed that is assigned to the patient"/> <formal value="The bed that is assigned to the patient."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Location"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=LOC].role.player[classCode=PLC, code=BED]"/> </mapping> <mapping> <identity value="v2"/> <map value="PV1-3-assigned patient location"/> </mapping> </definition> </element> <element> <path value="Encounter.hospitalization.accomodation.period"/> <definition> <short value="Period during which the patient was assigned the bed"/> <formal value="Period during which the patient was assigned the bed."/> <min value="0"/> <max value="1"/> <type> <code value="Period"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".effectiveTime"/> </mapping> </definition> </element> <element> <path value="Encounter.hospitalization.diet"/> <definition> <short value="Dietary restrictions for the patient"/> <formal value="Dietary restrictions for the patient."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="PatientDiet"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/encounter-diet"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=COMP].target[classCode=SBADM, moodCode=EVN, code="diet"]"/> </mapping> <mapping> <identity value="v2"/> <map value="PV1-38-diet type"/> </mapping> </definition> </element> <element> <path value="Encounter.hospitalization.specialCourtesy"/> <definition> <short value="Special courtesies (VIP, board member)"/> <formal value="Special courtesies (VIP, board member)."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="Courtesies"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/encounter-special-courtesy"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".specialCourtesiesCode"/> </mapping> <mapping> <identity value="v2"/> <map value="PV1-16-VIP indicator"/> </mapping> </definition> </element> <element> <path value="Encounter.hospitalization.specialArrangement"/> <definition> <short value="Wheelchair, translator, stretcher, etc"/> <formal value="Wheelchair, translator, stretcher, etc."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="Arrangements"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/encounter-special-arrangements"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".specialArrangementCode"/> </mapping> <mapping> <identity value="v2"/> <map value="PV1-15-ambulatory status / OBR-30-transportation mode / OBR-43-planned patient transport comment"/> </mapping> </definition> </element> <element> <path value="Encounter.hospitalization.destination"/> <definition> <short value="Location to which the patient is discharged"/> <formal value="Location to which the patient is discharged."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Location"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=DST]"/> </mapping> </definition> </element> <element> <path value="Encounter.hospitalization.dischargeDisposition"/> <definition> <short value="Category or kind of location after discharge"/> <formal value="Category or kind of location after discharge."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="DischargeDisp"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/encounter-discharge-disposition"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".dischargeDispositionCode"/> </mapping> <mapping> <identity value="v2"/> <map value="PV1-36-discharge disposition"/> </mapping> </definition> </element> <element> <path value="Encounter.hospitalization.dischargeDiagnosis"/> <definition> <short value="The final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete"/> <formal value="The final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Any"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=OUT].target[classCode=OBS, moodCode=EVN, code=ASSERTION].value"/> </mapping> </definition> </element> <element> <path value="Encounter.hospitalization.reAdmission"/> <definition> <short value="Is this hospitalization a readmission?"/> <formal value="Whether this hospitalization is a readmission."/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Propose at harmonization"/> </mapping> <mapping> <identity value="v2"/> <map value="PV1-13-re-admission indicator"/> </mapping> </definition> </element> <element> <path value="Encounter.location"/> <definition> <short value="List of locations the patient has been at"/> <formal value="List of locations at which the patient has been."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=LOC]"/> </mapping> </definition> </element> <element> <path value="Encounter.location.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Encounter.location.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Encounter.location.location"/> <definition> <short value="Location the encounter takes place"/> <formal value="The location where the encounter takes place."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Location"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".role"/> </mapping> <mapping> <identity value="v2"/> <map value="PV1-3-assigned patient location / PV1-6-prior patient location / PV1-11-temporary location / PV1-42-pending location / PV1-43-prior temporary location"/> </mapping> </definition> </element> <element> <path value="Encounter.location.period"/> <definition> <short value="Time period during which the patient was present at the location"/> <formal value="Time period during which the patient was present at the location."/> <min value="1"/> <max value="1"/> <type> <code value="Period"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".time"/> </mapping> </definition> </element> <element> <path value="Encounter.serviceProvider"/> <definition> <short value="Department or team providing care"/> <formal value="Department or team providing care."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Organization"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".particiaption[typeCode=PFM].role"/> </mapping> <mapping> <identity value="v2"/> <map value="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)"/> </mapping> </definition> </element> <element> <path value="Encounter.partOf"/> <definition> <short value="Another Encounter this encounter is part of"/> <formal value="Another Encounter of which this encounter is a part of (administratively or in time)."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Encounter"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=COMP].source[classCode=COMP, moodCode=EVN]"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="date"/> <type value="date"/> <documentation value="A date within the period the Encounter lasted"/> <xpath value="f:Encounter/f:period"/> </searchParam> <searchParam> <name value="identifier"/> <type value="token"/> <documentation value="Identifier(s) by which this encounter is known"/> <xpath value="f:Encounter/f:identifier"/> </searchParam> <searchParam> <name value="indication"/> <type value="reference"/> <documentation value="Reason the encounter takes place (resource)"/> <xpath value="f:Encounter/f:indication"/> </searchParam> <searchParam> <name value="length"/> <type value="number"/> <documentation value="Length of encounter in days"/> <xpath value="f:Encounter/f:length"/> </searchParam> <searchParam> <name value="location"/> <type value="reference"/> <documentation value="Location the encounter takes place"/> <xpath value="f:Encounter/f:location/f:location"/> </searchParam> <searchParam> <name value="location-period"/> <type value="date"/> <documentation value="Time period during which the patient was present at the location"/> <xpath value="f:Encounter/f:location/f:period"/> </searchParam> <searchParam> <name value="status"/> <type value="token"/> <documentation value="planned | in progress | onleave | finished | cancelled"/> <xpath value="f:Encounter/f:status"/> </searchParam> <searchParam> <name value="subject"/> <type value="reference"/> <documentation value="The patient present at the encounter"/> <xpath value="f:Encounter/f:subject"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="encounter-definitions.html#Encounter" 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."><b>Encounter</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="encounter-definitions.html#Encounter.identifier" title="Identifier(s) by which this encounter is known."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></identifier> <<a class="dict" href="encounter-definitions.html#Encounter.status" title="planned | in progress | onleave | finished | cancelled (this element modifies the meaning of other elements)"><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 href="encounter-state.html" style="color: navy">planned | in progress | onleave | finished | cancelled<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span> <<a class="dict" href="encounter-definitions.html#Encounter.class" title="inpatient | outpatient | ambulatory | emergency + (this element modifies the meaning of other elements)"><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 href="encounter-class.html" style="color: navy">inpatient | outpatient | ambulatory | emergency +<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span> <<a class="dict" href="encounter-definitions.html#Encounter.type" title="Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation)."><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 href="valueset-encounter-type.html" style="color: navy">Specific type of encounter<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></type> <<a class="dict" href="encounter-definitions.html#Encounter.subject" title="The patient present at the encounter."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></subject> <<a class="dict" href="encounter-definitions.html#Encounter.participant" title="The main practitioner responsible for providing the service."><b>participant</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> List of participants involved in the encounter<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span> --></span> <<a class="dict" href="encounter-definitions.html#Encounter.participant.type" title="Role of participant in encounter."><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 href="valueset-encounter-participant-type.html" style="color: navy">Role of participant in encounter<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></type> <<a class="dict" href="encounter-definitions.html#Encounter.participant.individual" title="Persons involved in the encounter other than the patient."><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"> Persons involved in the encounter other than the patient<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></individual> </participant> <<a class="dict" href="encounter-definitions.html#Encounter.period" title="The start and end time of the encounter."><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> <<a class="dict" href="encounter-definitions.html#Encounter.length" title="Quantity of time the encounter lasted. This excludes the time during leaves of absence."><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> <<a class="dict" href="encounter-definitions.html#Encounter.reason" title="Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis."><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 href="valueset-encounter-reason.html" style="color: navy">Reason the encounter takes place (code)<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></reason> <<a class="dict" href="encounter-definitions.html#Encounter.indication" title="Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis."><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> <<a class="dict" href="encounter-definitions.html#Encounter.priority" title="Indicates the urgency of the encounter."><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 href="valueset-encounter-priority.html" style="color: navy">Indicates the urgency of the encounter</a></span><span style="color: Gray"> --></span></priority> <<a class="dict" href="encounter-definitions.html#Encounter.hospitalization" title="Details about an admission to a clinic."><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> <<a class="dict" href="encounter-definitions.html#Encounter.hospitalization.preAdmissionIdentifier" title="Pre-admission identifier."><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> <<a class="dict" href="encounter-definitions.html#Encounter.hospitalization.origin" title="The location from which the patient came before admission."><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"> The location from which the patient came before admission</span><span style="color: Gray"> --></span></origin> <<a class="dict" href="encounter-definitions.html#Encounter.hospitalization.admitSource" title="From where patient was admitted (physician referral, transfer)."><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 href="valueset-encounter-admit-source.html" style="color: navy">From where patient was admitted (physician referral, transfer)</a></span><span style="color: Gray"> --></span></admitSource> <<a class="dict" href="encounter-definitions.html#Encounter.hospitalization.period" title="Period during which the patient was admitted."><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> <<a class="dict" href="encounter-definitions.html#Encounter.hospitalization.accomodation" title="Where the patient stays during this encounter."><b>accomodation</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Where the patient stays during this encounter --></span> <<a class="dict" href="encounter-definitions.html#Encounter.hospitalization.accomodation.bed" title="The bed that is assigned to the patient."><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> <<a class="dict" href="encounter-definitions.html#Encounter.hospitalization.accomodation.period" title="Period during which the patient was assigned the bed."><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> </accomodation> <<a class="dict" href="encounter-definitions.html#Encounter.hospitalization.diet" title="Dietary restrictions for the patient."><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 href="valueset-encounter-diet.html" style="color: navy">Dietary restrictions for the patient</a></span><span style="color: Gray"> --></span></diet> <<a class="dict" href="encounter-definitions.html#Encounter.hospitalization.specialCourtesy" title="Special courtesies (VIP, board member)."><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 href="valueset-encounter-special-courtesy.html" style="color: navy">Special courtesies (VIP, board member)</a></span><span style="color: Gray"> --></span></specialCourtesy> <<a class="dict" href="encounter-definitions.html#Encounter.hospitalization.specialArrangement" title="Wheelchair, translator, stretcher, etc."><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 href="valueset-encounter-special-arrangements.html" style="color: navy">Wheelchair, translator, stretcher, etc</a></span><span style="color: Gray"> --></span></specialArrangement> <<a class="dict" href="encounter-definitions.html#Encounter.hospitalization.destination" title="Location to which the patient is discharged."><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> <<a class="dict" href="encounter-definitions.html#Encounter.hospitalization.dischargeDisposition" title="Category or kind of location after discharge."><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 href="valueset-encounter-discharge-disposition.html" style="color: navy">Category or kind of location after discharge</a></span><span style="color: Gray"> --></span></dischargeDisposition> <<a class="dict" href="encounter-definitions.html#Encounter.hospitalization.dischargeDiagnosis" title="The final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete."><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"> 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> <<a class="dict" href="encounter-definitions.html#Encounter.hospitalization.reAdmission" title="Whether this hospitalization is a 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> </hospitalization> <<a class="dict" href="encounter-definitions.html#Encounter.location" title="List of locations at which the patient has been."><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> <<a class="dict" href="encounter-definitions.html#Encounter.location.location" title="The location where the encounter takes place."><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> <<a class="dict" href="encounter-definitions.html#Encounter.location.period" title="Time period during which the patient was present at the location."><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> </location> <<a class="dict" href="encounter-definitions.html#Encounter.serviceProvider" title="Department or team providing care."><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> <<a class="dict" href="encounter-definitions.html#Encounter.partOf" title="Another Encounter of which this encounter is a part of (administratively or in time)."><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> </Encounter> </pre></div> </summary> </entry> <entry> <title>"familyhistory" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/familyhistory</id> <link href="http://hl7.org/implement/standards/fhir/familyhistory.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory" title="Significant health events and conditions for people related to the subject relevant in the context of care for the subject."><b>FamilyHistory</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.identifier" 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)."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></identifier> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.subject" title="The person who this history concerns."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></subject> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.note" title="Conveys information about family history not specific to individual relations."><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> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.relation" title="The related person. Each FamilyHistory resource contains the entire family history for a single person."><b>relation</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Relative described by history --></span> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.relation.name" title="This will either be a name or a description. E.g. "Aunt Susan", "my cousin with the red hair"."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.relation.relationship" title="The type of relationship this person has to the patient (father, mother, brother etc.)."><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 href="v3/vs/FamilyMember/index.html" style="color: navy">Relationship to the subject<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a><span style="color: Gray"> --></span></relationship> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.relation.born_x_" title="The actual or approximate date of birth of the relative."><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]> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.relation.deceased_x_" 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."><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]> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.relation.note" 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."><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> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.relation.condition" 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."><b>condition</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Condition that the related person had --></span> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.relation.condition.type" 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."><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> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.relation.condition.outcome" title="Indicates what happened as a result of this condition. If the condition resulted in death, deceased date is captured on the relation."><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> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.relation.condition.onset_x_" 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."><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]> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.relation.condition.note" title="An area where general notes can be placed about this specific condition."><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> </condition> </relation> </FamilyHistory> </pre></div> </text> <name value="familyhistory"/> <publisher value="FHIR Project"/> <description value="Basic Profile. Significant health events and conditions for people related to the subject relevant in the context of care for the subject."/> <status value="draft"/> <date value="2014-09-30"/> <requirements value="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. This 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. The entire family history for an individual is stored in a single resource."/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <structure> <type value="FamilyHistory"/> <publish value="true"/> <element> <path value="FamilyHistory"/> <definition> <short value="Information about patient's relatives, relevant for patient"/> <formal value="Significant health events and conditions for people related to the subject relevant in the context of care for the subject."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Observation[classCode=OBS, moodCode=EVN]"/> </mapping> <mapping> <identity value="v2"/> <map value="Not in scope for v2"/> </mapping> </definition> </element> <element> <path value="FamilyHistory.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="FamilyHistory.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="FamilyHistory.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="FamilyHistory.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="FamilyHistory.identifier"/> <definition> <short value="External Id(s) for this record"/> <formal value="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 value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="id"/> </mapping> </definition> </element> <element> <path value="FamilyHistory.subject"/> <definition> <short value="Patient history is about"/> <formal value="The person who this history concerns."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="participation[typeCode=SBJ].role"/> </mapping> </definition> </element> <element> <path value="FamilyHistory.note"/> <definition> <short value="Additional details not covered elsewhere"/> <formal value="Conveys information about family history not specific to individual relations."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value"/> </mapping> </definition> </element> <element> <path value="FamilyHistory.relation"/> <definition> <short value="Relative described by history"/> <formal value="The related person. Each FamilyHistory resource contains the entire family history for a single person."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="participation[typeCode=SBJ].role[classCode=PAT].player[classCode<LIV, moodCode=INSTANCE].scopedRo le"/> </mapping> </definition> </element> <element> <path value="FamilyHistory.relation.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="FamilyHistory.relation.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="FamilyHistory.relation.name"/> <definition> <short value="The family member described"/> <formal value="This will either be a name or a description. E.g. "Aunt Susan", "my cousin with the red hair"."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="name"/> </mapping> </definition> </element> <element> <path value="FamilyHistory.relation.relationship"/> <definition> <short value="Relationship to the subject"/> <formal value="The type of relationship this person has to the patient (father, mother, brother etc.)."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="FamilialRelationship"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/v3/vs/FamilyMember"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="code"/> </mapping> </definition> </element> <element> <path value="FamilyHistory.relation.born[x]"/> <definition> <short value="(approximate) date of birth"/> <formal value="The actual or approximate date of birth of the relative."/> <min value="0"/> <max value="1"/> <type> <code value="Period"/> </type> <type> <code value="date"/> </type> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="player[classCode=LIV, determinerCode=INSTANCE]. birthDate (could be URG)"/> </mapping> </definition> </element> <element> <path value="FamilyHistory.relation.deceased[x]"/> <definition> <short value="Dead? How old/when?"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <type> <code value="Age"/> </type> <type> <code value="Range"/> </type> <type> <code value="date"/> </type> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="player[classCode=LIV, determinerCode=INSTANCE].deceasedInd, deceasedDate (could be URG) For age, you'd hang an observation off the role"/> </mapping> </definition> </element> <element> <path value="FamilyHistory.relation.note"/> <definition> <short value="General note about related person"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value"/> </mapping> </definition> </element> <element> <path value="FamilyHistory.relation.condition"/> <definition> <short value="Condition that the related person had"/> <formal value="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 value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION, value<Diagnosis]"/> </mapping> </definition> </element> <element> <path value="FamilyHistory.relation.condition.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="FamilyHistory.relation.condition.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="FamilyHistory.relation.condition.type"/> <definition> <short value="Condition suffered by relation"/> <formal value="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 value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".value"/> </mapping> </definition> </element> <element> <path value="FamilyHistory.relation.condition.outcome"/> <definition> <short value="deceased | permanent disability | etc."/> <formal value="Indicates what happened as a result of this condition. If the condition resulted in death, deceased date is captured on the relation."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="ConditionOutcome"/> <isExtensible value="true"/> <conformance value="preferred"/> <description value="The result of the condition for the patient. E.g. death, permanent disability, temporary disability, etc."/> </binding> <mapping> <identity value="rim"/> <map value="outboundRelationship[typeCode=OUTC)].target[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION].val ue"/> </mapping> </definition> </element> <element> <path value="FamilyHistory.relation.condition.onset[x]"/> <definition> <short value="When condition first manifested"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="Age"/> </type> <type> <code value="Range"/> </type> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="Subject Age at measurement", value<Diagnosis].value[@xsi:typeCode='TS' or 'IVL_TS'] Use originalText for string"/> </mapping> </definition> </element> <element> <path value="FamilyHistory.relation.condition.note"/> <definition> <short value="Extra information about condition"/> <formal value="An area where general notes can be placed about this specific condition."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="subject"/> <type value="reference"/> <documentation value="The identity of a subject to list family history items for"/> <xpath value="f:FamilyHistory/f:subject"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory" title="Significant health events and conditions for people related to the subject relevant in the context of care for the subject."><b>FamilyHistory</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.identifier" 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)."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></identifier> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.subject" title="The person who this history concerns."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></subject> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.note" title="Conveys information about family history not specific to individual relations."><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> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.relation" title="The related person. Each FamilyHistory resource contains the entire family history for a single person."><b>relation</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Relative described by history --></span> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.relation.name" title="This will either be a name or a description. E.g. "Aunt Susan", "my cousin with the red hair"."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.relation.relationship" title="The type of relationship this person has to the patient (father, mother, brother etc.)."><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 href="v3/vs/FamilyMember/index.html" style="color: navy">Relationship to the subject<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a><span style="color: Gray"> --></span></relationship> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.relation.born_x_" title="The actual or approximate date of birth of the relative."><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]> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.relation.deceased_x_" 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."><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]> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.relation.note" 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."><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> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.relation.condition" 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."><b>condition</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Condition that the related person had --></span> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.relation.condition.type" 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."><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> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.relation.condition.outcome" title="Indicates what happened as a result of this condition. If the condition resulted in death, deceased date is captured on the relation."><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> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.relation.condition.onset_x_" 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."><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]> <<a class="dict" href="familyhistory-definitions.html#FamilyHistory.relation.condition.note" title="An area where general notes can be placed about this specific condition."><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> </condition> </relation> </FamilyHistory> </pre></div> </summary> </entry> <entry> <title>"group" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/group</id> <link href="http://hl7.org/implement/standards/fhir/group.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="group-definitions.html#Group" 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."><b>Group</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="group-definitions.html#Group.identifier" title="A unique business identifier for this group."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></identifier> <<a class="dict" href="group-definitions.html#Group.type" title="Identifies the broad classification of the kind of resources the group includes."><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 href="group-type.html" style="color: navy">person | animal | practitioner | device | medication | substance<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span> <<a class="dict" href="group-definitions.html#Group.actual" 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."><b>actual</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#boolean">boolean</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: Can only have members if group is "actual""><b><img alt="??" src="lock.png"/> 1..1</b></span> <span style="color: navy">Descriptive or actual<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="group-definitions.html#Group.code" title="Provides a specific type of resource the group includes. E.g. "cow", "syringe", etc."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></code> <<a class="dict" href="group-definitions.html#Group.name" title="A label assigned to the group for human identification and communication."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="group-definitions.html#Group.quantity" title="A count of the number of resource instances that are part of the group."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="group-definitions.html#Group.characteristic" title="Identifies the traits shared by members of the group."><b>characteristic</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Trait of group members --></span> <<a class="dict" href="group-definitions.html#Group.characteristic.code" title="A code that identifies the kind of trait being asserted."><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> <<a class="dict" href="group-definitions.html#Group.characteristic.value_x_" title="The value of the trait that holds (or does not hold - see 'exclude') for members of the group."><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]> <<a class="dict" href="group-definitions.html#Group.characteristic.exclude" 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)"><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> </characteristic> <<a class="dict" href="group-definitions.html#Group.member" title="Identifies the resource instances that are members of the group."><b>member</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: Can only have members if group is "actual""><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> </Group> </pre></div> </text> <name value="group"/> <publisher value="FHIR Project"/> <description value="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 value="draft"/> <date value="2014-09-30"/> <requirements value="Scope and Usage Use Cases The group resource is used in one of two ways: * To define a group of specific people, animals, devices, etc. that is being tracked, examined or otherwise referenced as part of healthcare-related activities * To define a set of *possible* people, animals, devices, etc. that are of interest for some intended future healthcare-related activities Examples 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. Both use cases are handled by a single resource because the data elements captured tend to be similar."/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <structure> <type value="Group"/> <publish value="true"/> <element> <path value="Group"/> <definition> <short value="Group of multiple entities"/> <formal value="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 value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <constraint> <key value="1"/> <name value="No members for non-actual"/> <severity value="error"/> <human value="Can only have members if group is "actual""/> <xpath value="f:actual/@value='true' or not(exists(f:member))"/> </constraint> <constraint> <key value="4"/> <name value="No more members than quantity"/> <severity value="error"/> <human value="Can't have more members associated with the group than the value specified for "quantity""/> <xpath value="not(f:quantity) or not(f:member) or not(f:quantity>count(f:member))"/> </constraint> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Entity[determinerCode="GRP" or determinerCode="GRP_KIND"]"/> </mapping> </definition> </element> <element> <path value="Group.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Group.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Group.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Group.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Group.identifier"/> <definition> <short value="Unique id"/> <formal value="A unique business identifier for this group."/> <min value="0"/> <max value="1"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="unique(./id[displayable="true" and scope="OBJ"])"/> </mapping> </definition> </element> <element> <path value="Group.type"/> <definition> <short value="person | animal | practitioner | device | medication | substance"/> <formal value="Identifies the broad classification of the kind of resources the group includes."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="GroupType"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/group-type"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="person: ./classCode="PSN" animal: ./classCode="ANM" device: ./classCode=" DEV" medication: ./classCode="MMAT" and ./playedRole[isNormalRole() and classCode="THER"] food: ./classCode="FOOD""/> </mapping> </definition> </element> <element> <path value="Group.actual"/> <definition> <short value="Descriptive or actual"/> <formal value="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 value="1"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="true: ./determinerCode="GRP" false: ./determinerCode="GRP_KIND""/> </mapping> </definition> </element> <element> <path value="Group.code"/> <definition> <short value="Kind of Group members"/> <formal value="Provides a specific type of resource the group includes. E.g. "cow", "syringe", etc."/> <comments value="This would generally be omitted for Person resources."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="GroupKind"/> <isExtensible value="true"/> <conformance value="preferred"/> <description value="Kind of particular resource. E.g. cow, syringe, lake, etc."/> </binding> <mapping> <identity value="rim"/> <map value="./code"/> </mapping> </definition> </element> <element> <path value="Group.name"/> <definition> <short value="Label for Group"/> <formal value="A label assigned to the group for human identification and communication."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./name[type="ST"]"/> </mapping> </definition> </element> <element> <path value="Group.quantity"/> <definition> <short value="Number of members"/> <formal value="A count of the number of resource instances that are part of the group."/> <min value="0"/> <max value="1"/> <type> <code value="integer"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./quantity"/> </mapping> </definition> </element> <element> <path value="Group.characteristic"/> <definition> <short value="Trait of group members"/> <formal value="Identifies the traits shared by members of the group."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./playedRole[isNormalRole()]/participation[isNormalParticipation() and typeCode="SBJ"]/act [isNormalAct and classCode="OBS" and moodCode="EVN"]"/> </mapping> </definition> </element> <element> <path value="Group.characteristic.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Group.characteristic.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Group.characteristic.code"/> <definition> <short value="Kind of characteristic"/> <formal value="A code that identifies the kind of trait being asserted."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="GroupCharacteristicKind"/> <isExtensible value="true"/> <conformance value="preferred"/> <description value="List of characteristics used to describe group members. E.g. gender, age, owner, location, etc."/> </binding> <mapping> <identity value="rim"/> <map value="./code"/> </mapping> </definition> </element> <element> <path value="Group.characteristic.value[x]"/> <definition> <short value="Value held by characteristic"/> <formal value="The value of the trait that holds (or does not hold - see 'exclude') for members of the group."/> <comments value="For Range, it means members of the group have a value that falls somewhere within the specified range."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <type> <code value="boolean"/> </type> <type> <code value="Quantity"/> </type> <type> <code value="Range"/> </type> <isModifier value="false"/> <binding> <name value="GroupCharacteristicValue"/> <isExtensible value="true"/> <conformance value="preferred"/> <description value="Value of descriptive member characteristic. E.g. red, male, pneumonia, caucasian, etc."/> </binding> <mapping> <identity value="rim"/> <map value="./value"/> </mapping> </definition> </element> <element> <path value="Group.characteristic.exclude"/> <definition> <short value="Group includes or excludes"/> <formal value="If true, indicates the characteristic is one that is NOT held by members of the group."/> <comments value="This is labeled as "Is Modifier" because applications cannot wrongly include excluded members as included or vice versa."/> <min value="1"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="./valueNegationInd"/> </mapping> </definition> </element> <element> <path value="Group.member"/> <definition> <short value="Who is in group"/> <formal value="Identifies the resource instances that are members of the group."/> <min value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Device"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Medication"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Substance"/> </type> <constraint> <key value="3"/> <name value="Group member type agreement"/> <severity value="error"/> <human value="Member resource types SHALL agree with group type"/> <xpath value="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'))"/> </constraint> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./scopedRole[isNormalRole() and classCode="MBR"]/player"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="actual"/> <type value="token"/> <documentation value="Descriptive or actual"/> <xpath value="f:Group/f:actual"/> </searchParam> <searchParam> <name value="characteristic"/> <type value="token"/> <documentation value="Kind of characteristic"/> <xpath value="f:Group/f:characteristic/f:code"/> </searchParam> <searchParam> <name value="characteristic-value"/> <type value="composite"/> <documentation value="A composite of both characteristic and value"/> </searchParam> <searchParam> <name value="code"/> <type value="token"/> <documentation value="The kind of resources contained"/> <xpath value="f:Group/f:code"/> </searchParam> <searchParam> <name value="exclude"/> <type value="token"/> <documentation value="Group includes or excludes"/> <xpath value="f:Group/f:characteristic/f:exclude"/> </searchParam> <searchParam> <name value="identifier"/> <type value="token"/> <documentation value="Unique id"/> <xpath value="f:Group/f:identifier"/> </searchParam> <searchParam> <name value="member"/> <type value="reference"/> <documentation value="Who is in group"/> <xpath value="f:Group/f:member"/> </searchParam> <searchParam> <name value="type"/> <type value="token"/> <documentation value="The type of resources the group contains"/> <xpath value="f:Group/f:type"/> </searchParam> <searchParam> <name value="value"/> <type value="token"/> <documentation value="Value held by characteristic"/> <xpath value="f:Group/f:characteristic/f:value[x]"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="group-definitions.html#Group" 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."><b>Group</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="group-definitions.html#Group.identifier" title="A unique business identifier for this group."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></identifier> <<a class="dict" href="group-definitions.html#Group.type" title="Identifies the broad classification of the kind of resources the group includes."><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 href="group-type.html" style="color: navy">person | animal | practitioner | device | medication | substance<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span> <<a class="dict" href="group-definitions.html#Group.actual" 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."><b>actual</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#boolean">boolean</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: Can only have members if group is "actual""><b><img alt="??" src="lock.png"/> 1..1</b></span> <span style="color: navy">Descriptive or actual<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="group-definitions.html#Group.code" title="Provides a specific type of resource the group includes. E.g. "cow", "syringe", etc."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></code> <<a class="dict" href="group-definitions.html#Group.name" title="A label assigned to the group for human identification and communication."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="group-definitions.html#Group.quantity" title="A count of the number of resource instances that are part of the group."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="group-definitions.html#Group.characteristic" title="Identifies the traits shared by members of the group."><b>characteristic</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Trait of group members --></span> <<a class="dict" href="group-definitions.html#Group.characteristic.code" title="A code that identifies the kind of trait being asserted."><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> <<a class="dict" href="group-definitions.html#Group.characteristic.value_x_" title="The value of the trait that holds (or does not hold - see 'exclude') for members of the group."><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]> <<a class="dict" href="group-definitions.html#Group.characteristic.exclude" 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)"><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> </characteristic> <<a class="dict" href="group-definitions.html#Group.member" title="Identifies the resource instances that are members of the group."><b>member</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: Can only have members if group is "actual""><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> </Group> </pre></div> </summary> </entry> <entry> <title>"imagingstudy" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/imagingstudy</id> <link href="http://hl7.org/implement/standards/fhir/imagingstudy.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy" 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."><b>ImagingStudy</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.dateTime" title="Date and Time the study took place."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.subject" title="Who the images are of."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.uid" title="Formal identifier for the study."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.accessionNo" title="Accession Number."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.identifier" title="Other identifiers for the study."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.order" title="A list of the diagnostic orders that resulted in this imaging study being performed."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.modality" 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)."><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 href="imaging-modality.html" style="color: navy">All series.modality if actual acquisition modalities</a></span><span style="color: Gray"> --></span> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.referrer" title="The requesting/referring physician."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.availability" title="Availability of study (online, offline or nearline)."><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 href="instance-availability.html" style="color: navy">ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056)</a></span><span style="color: Gray"> --></span> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.url" title="WADO-RS URI where Study is available."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.numberOfSeries" title="Number of Series in Study."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.numberOfInstances" title="Number of SOP Instances in Study."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.clinicalInformation" title="Diagnoses etc provided with request."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.procedure" title="Type of procedure performed."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.interpreter" title="Who read study and interpreted the images."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.description" title="Institution-generated description or classification of the Study (component) performed."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series" title="Each study has one or more series of image instances."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series.number" title="The number of this series in the overall sequence."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series.modality" title="The modality of this series sequence."><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 href="modality.html" style="color: navy">The modality of the instances in the series (0008,0060)</a></span><span style="color: Gray"> --></span> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series.uid" title="Formal identifier for this series."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series.description" title="A description of the series."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series.numberOfInstances" title="Sequence that contains attributes from the."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series.availability" title="Availability of series (online, offline or nearline)."><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 href="instance-availability.html" style="color: navy">ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056)</a></span><span style="color: Gray"> --></span> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series.url" title="WADO-RS URI where Series is available."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series.bodySite" title="Body part examined. See DICOM Part 16 Annex L for the mapping from DICOM to Snomed."><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 href="valueset-body-site.html" style="color: navy">Body part examined (Map from 0018,0015)</a></span><span style="color: Gray"> --></span></bodySite> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series.dateTime" title="When the series started."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series.instance" title="A single image taken from a patient."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series.instance.number" title="The number of this image in the series."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series.instance.uid" title="Formal identifier for this image."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series.instance.sopclass" title="DICOM Image type."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series.instance.type" title="Type of instance (image etc) (0004,1430)."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series.instance.title" title="Description (0070,0080 | 0040,A043 > 0008,0104 | 0042,0010 | 0008,0008)."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series.instance.url" title="WADO-RS url where image is available."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series.instance.attachment" title="A FHIR resource with content for this instance."><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> </instance> </series> </ImagingStudy> </pre></div> </text> <name value="imagingstudy"/> <publisher value="FHIR Project"/> <description value="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 value="draft"/> <date value="2014-09-30"/> <requirements value="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. This 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 value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="dicom"/> <uri value="http://nema.org/dicom"/> <name value="DICOM"/> </mapping> <structure> <type value="ImagingStudy"/> <publish value="true"/> <element> <path value="ImagingStudy"/> <definition> <short value="A set of images produced in single study (one or more series of references images)"/> <formal value="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 value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Act[classCode=COMPOSITION, moodCode=EVN]"/> </mapping> <mapping> <identity value="dicom"/> <map value="Reference IHE radiology TF vol 2 table 4.14.1"/> </mapping> </definition> </element> <element> <path value="ImagingStudy.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ImagingStudy.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ImagingStudy.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ImagingStudy.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ImagingStudy.dateTime"/> <definition> <short value="When the study was performed"/> <formal value="Date and Time the study took place."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".effectiveTime"/> </mapping> <mapping> <identity value="dicom"/> <map value="0008,0020+0008,0030"/> </mapping> </definition> </element> <element> <path value="ImagingStudy.subject"/> <definition> <short value="Who the images are of"/> <formal value="Who the images are of."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=SBJ].role"/> </mapping> <mapping> <identity value="dicom"/> <map value="0010/*"/> </mapping> </definition> </element> <element> <path value="ImagingStudy.uid"/> <definition> <short value="Formal identifier for the study (0020,000D)"/> <formal value="Formal identifier for the study."/> <min value="1"/> <max value="1"/> <type> <code value="oid"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> <mapping> <identity value="dicom"/> <map value="0020,000D"/> </mapping> </definition> </element> <element> <path value="ImagingStudy.accessionNo"/> <definition> <short value="Accession Number (0008,0050)"/> <formal value="Accession Number."/> <min value="0"/> <max value="1"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=COMP].source[classCode=ACSN, moodCode=EVN].id"/> </mapping> <mapping> <identity value="dicom"/> <map value="0008,0050"/> </mapping> </definition> </element> <element> <path value="ImagingStudy.identifier"/> <definition> <short value="Other identifiers for the study (0020,0010)"/> <formal value="Other identifiers for the study."/> <min value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id (no means to distinguish from uid)"/> </mapping> <mapping> <identity value="dicom"/> <map value="0020,0010"/> </mapping> </definition> </element> <element> <path value="ImagingStudy.order"/> <definition> <short value="Order(s) that caused this study to be performed"/> <formal value="A list of the diagnostic orders that resulted in this imaging study being performed."/> <comments value="The order(s) can be inferred from information such as accession numbers, but the details of this depend on local workflow management. Note that there is a many-many relationship between orders and studies."/> <min value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/DiagnosticOrder"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=FLFS].target[classCode=DGIMG, moodCode=RQO]"/> </mapping> </definition> </element> <element> <path value="ImagingStudy.modality"/> <definition> <short value="All series.modality if actual acquisition modalities"/> <formal value="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 value="0"/> <max value="*"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="ImagingModality"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/imaging-modality"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> <mapping> <identity value="dicom"/> <map value="0008,0061"/> </mapping> </definition> </element> <element> <path value="ImagingStudy.referrer"/> <definition> <short value="Referring physician (0008,0090)"/> <formal value="The requesting/referring physician."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=FLFS].target[classCode=DGIMG, moodCode=RQO].participation[typeCode=AU T].role"/> </mapping> <mapping> <identity value="dicom"/> <map value="0008,0090"/> </mapping> </definition> </element> <element> <path value="ImagingStudy.availability"/> <definition> <short value="ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056)"/> <formal value="Availability of study (online, offline or nearline)."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="InstanceAvailability"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/instance-availability"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="Not supported"/> </mapping> <mapping> <identity value="dicom"/> <map value="0008,0056"/> </mapping> </definition> </element> <element> <path value="ImagingStudy.url"/> <definition> <short value="Retrieve URI (0008,1190)"/> <formal value="WADO-RS URI where Study is available."/> <min value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".text.reference"/> </mapping> <mapping> <identity value="dicom"/> <map value="0008,1190"/> </mapping> </definition> </element> <element> <path value="ImagingStudy.numberOfSeries"/> <definition> <short value="Number of Study Related Series (0020,1206)"/> <formal value="Number of Series in Study."/> <min value="1"/> <max value="1"/> <type> <code value="integer"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=OBSSER, moodCode=EVN].repeatN umber"/> </mapping> <mapping> <identity value="dicom"/> <map value="(0020,1206)"/> </mapping> </definition> </element> <element> <path value="ImagingStudy.numberOfInstances"/> <definition> <short value="Number of Study Related Instances (0020,1208)"/> <formal value="Number of SOP Instances in Study."/> <min value="1"/> <max value="1"/> <type> <code value="integer"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=DGIMG, moodCode=EVN].repeatNu mber"/> </mapping> <mapping> <identity value="dicom"/> <map value="(0020,1208)"/> </mapping> </definition> </element> <element> <path value="ImagingStudy.clinicalInformation"/> <definition> <short value="Diagnoses etc with request (0040,1002)"/> <formal value="Diagnoses etc provided with request."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=PERT].target"/> </mapping> <mapping> <identity value="dicom"/> <map value="0040,1002, 0008,1080"/> </mapping> </definition> </element> <element> <path value="ImagingStudy.procedure"/> <definition> <short value="Type of procedure performed (0008,1032)"/> <formal value="Type of procedure performed."/> <min value="0"/> <max value="*"/> <type> <code value="Coding"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=COMP].target[classCode=PROC, moodCode=EVN]"/> </mapping> <mapping> <identity value="dicom"/> <map value="0008,1032"/> </mapping> </definition> </element> <element> <path value="ImagingStudy.interpreter"/> <definition> <short value="Who interpreted images (0008,1060)"/> <formal value="Who read study and interpreted the images."/> <comments value="or is this 4008,010C?."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=PRF].role"/> </mapping> <mapping> <identity value="dicom"/> <map value="0008,1060"/> </mapping> </definition> </element> <element> <path value="ImagingStudy.description"/> <definition> <short value="Institution-generated description (0008,1030)"/> <formal value="Institution-generated description or classification of the Study (component) performed."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".text"/> </mapping> <mapping> <identity value="dicom"/> <map value="0008,1030"/> </mapping> </definition> </element> <element> <path value="ImagingStudy.series"/> <definition> <short value="Each study has one or more series of instances"/> <formal value="Each study has one or more series of image instances."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=COMP].target[classCode=OBSSER, moodCode=EVN]"/> </mapping> </definition> </element> <element> <path value="ImagingStudy.series.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ImagingStudy.series.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ImagingStudy.series.number"/> <definition> <short value="Number of this series in overall sequence (0020,0011)"/> <formal value="The number of this series in the overall sequence."/> <min value="0"/> <max value="1"/> <type> <code value="integer"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".inboundRelationship[type=COMP, source[classCode=COMPOSITION, moodCode=EVN]].sequenceNumber"/> </mapping> <mapping> <identity value="dicom"/> <map value="0020,0011"/> </mapping> </definition> </element> <element> <path value="ImagingStudy.series.modality"/> <definition> <short value="The modality of the instances in the series (0008,0060)"/> <formal value="The modality of this series sequence."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="Modality"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/modality"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> <mapping> <identity value="dicom"/> <map value="0008,0060"/> </mapping> </definition> </element> <element> <path value="ImagingStudy.series.uid"/> <definition> <short value="Formal identifier for this series (0020,000E)"/> <formal value="Formal identifier for this series."/> <min value="1"/> <max value="1"/> <type> <code value="oid"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> <mapping> <identity value="dicom"/> <map value="0020,000E"/> </mapping> </definition> </element> <element> <path value="ImagingStudy.series.description"/> <definition> <short value="A description of the series (0008,103E)"/> <formal value="A description of the series."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".text"/> </mapping> <mapping> <identity value="dicom"/> <map value="0008,103E"/> </mapping> </definition> </element> <element> <path value="ImagingStudy.series.numberOfInstances"/> <definition> <short value="Number of Series Related Instances (0020,1209)"/> <formal value="Sequence that contains attributes from the."/> <min value="1"/> <max value="1"/> <type> <code value="integer"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=DGIMG, moodCode=EVN].repeatNu mber"/> </mapping> <mapping> <identity value="dicom"/> <map value="0020,1209"/> </mapping> </definition> </element> <element> <path value="ImagingStudy.series.availability"/> <definition> <short value="ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056)"/> <formal value="Availability of series (online, offline or nearline)."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="InstanceAvailability"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/instance-availability"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=COMP]. source[classCode=OBS, moodCode=EVN, code="availability&quo t;].value"/> </mapping> <mapping> <identity value="dicom"/> <map value="0008,0056"/> </mapping> </definition> </element> <element> <path value="ImagingStudy.series.url"/> <definition> <short value="Retrieve URI (0008,1115 > 0008,1190)"/> <formal value="WADO-RS URI where Series is available."/> <min value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".text.reference"/> </mapping> <mapping> <identity value="dicom"/> <map value="0008,1115 > 0008,1190"/> </mapping> </definition> </element> <element> <path value="ImagingStudy.series.bodySite"/> <definition> <short value="Body part examined (Map from 0018,0015)"/> <formal value="Body part examined. See DICOM Part 16 Annex L for the mapping from DICOM to Snomed."/> <min value="0"/> <max value="1"/> <type> <code value="Coding"/> </type> <isModifier value="false"/> <binding> <name value="BodySite"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/body-site"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".targetSiteCode"/> </mapping> <mapping> <identity value="dicom"/> <map value="0018,0015"/> </mapping> </definition> </element> <element> <path value="ImagingStudy.series.dateTime"/> <definition> <short value="When the series started"/> <formal value="When the series started."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".effectiveTime"/> </mapping> </definition> </element> <element> <path value="ImagingStudy.series.instance"/> <definition> <short value="A single instance taken from a patient (image or other)"/> <formal value="A single image taken from a patient."/> <min value="1"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=COMP].target[classCode=DGIMG, moodCode=EVN]"/> </mapping> </definition> </element> <element> <path value="ImagingStudy.series.instance.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ImagingStudy.series.instance.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ImagingStudy.series.instance.number"/> <definition> <short value="The number of this instance in the series (0020,0013)"/> <formal value="The number of this image in the series."/> <min value="0"/> <max value="1"/> <type> <code value="integer"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=COMP, source[classCode=OBSSER, moodCode=EVN]].sequenceNumber"/> </mapping> <mapping> <identity value="dicom"/> <map value="0020,0013"/> </mapping> </definition> </element> <element> <path value="ImagingStudy.series.instance.uid"/> <definition> <short value="Formal identifier for this instance (0008,0018)"/> <formal value="Formal identifier for this image."/> <min value="1"/> <max value="1"/> <type> <code value="oid"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> <mapping> <identity value="dicom"/> <map value="0008,0018"/> </mapping> </definition> </element> <element> <path value="ImagingStudy.series.instance.sopclass"/> <definition> <short value="DICOM class type (0008,0016)"/> <formal value="DICOM Image type."/> <min value="1"/> <max value="1"/> <type> <code value="oid"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=COMP]. source[classCode=OBS, moodCode=EVN, code="sop class"].value"/> </mapping> <mapping> <identity value="dicom"/> <map value="0008,0016"/> </mapping> </definition> </element> <element> <path value="ImagingStudy.series.instance.type"/> <definition> <short value="Type of instance (image etc) (0004,1430)"/> <formal value="Type of instance (image etc) (0004,1430)."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> <mapping> <identity value="dicom"/> <map value="0004,1430"/> </mapping> </definition> </element> <element> <path value="ImagingStudy.series.instance.title"/> <definition> <short value="Description (0070,0080 | 0040,A043 > 0008,0104 | 0042,0010 | 0008,0008)"/> <formal value="Description (0070,0080 | 0040,A043 > 0008,0104 | 0042,0010 | 0008,0008)."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".title"/> </mapping> <mapping> <identity value="dicom"/> <map value="0070,0080 | 0040,A043 > 0008,0104 | 0042,0010 | 0008,0008"/> </mapping> </definition> </element> <element> <path value="ImagingStudy.series.instance.url"/> <definition> <short value="WADO-RS service where instance is available (0008,1199 > 0008,1190)"/> <formal value="WADO-RS url where image is available."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".text.reference"/> </mapping> <mapping> <identity value="dicom"/> <map value="0008,1199 > 0008,1190"/> </mapping> </definition> </element> <element> <path value="ImagingStudy.series.instance.attachment"/> <definition> <short value="A FHIR resource with content for this instance"/> <formal value="A FHIR resource with content for this instance."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Any"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".text.binary"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="accession"/> <type value="token"/> <documentation value="The accession id for the image"/> <xpath value="f:ImagingStudy/f:accessionNo"/> </searchParam> <searchParam> <name value="bodysite"/> <type value="token"/> <documentation value="Body part examined (Map from 0018,0015)"/> <xpath value="f:ImagingStudy/f:series/f:bodySite"/> </searchParam> <searchParam> <name value="date"/> <type value="date"/> <documentation value="The date the study was done was taken"/> <xpath value="f:ImagingStudy/f:dateTime"/> </searchParam> <searchParam> <name value="dicom-class"/> <type value="token"/> <documentation value="DICOM class type (0008,0016)"/> <xpath value="f:ImagingStudy/f:series/f:instance/f:sopclass"/> </searchParam> <searchParam> <name value="modality"/> <type value="token"/> <documentation value="The modality of the image"/> <xpath value="f:ImagingStudy/f:series/f:modality"/> </searchParam> <searchParam> <name value="series"/> <type value="token"/> <documentation value="The series id for the image"/> <xpath value="f:ImagingStudy/f:series/f:uid"/> </searchParam> <searchParam> <name value="size"/> <type value="number"/> <documentation value="The size of the image in MB - may include > or < in the value"/> </searchParam> <searchParam> <name value="study"/> <type value="token"/> <documentation value="The study id for the image"/> <xpath value="f:ImagingStudy/f:uid"/> </searchParam> <searchParam> <name value="subject"/> <type value="reference"/> <documentation value="Who the study is about"/> <xpath value="f:ImagingStudy/f:subject"/> </searchParam> <searchParam> <name value="uid"/> <type value="token"/> <documentation value="Formal identifier for this instance (0008,0018)"/> <xpath value="f:ImagingStudy/f:series/f:instance/f:uid"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy" 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."><b>ImagingStudy</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.dateTime" title="Date and Time the study took place."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.subject" title="Who the images are of."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.uid" title="Formal identifier for the study."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.accessionNo" title="Accession Number."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.identifier" title="Other identifiers for the study."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.order" title="A list of the diagnostic orders that resulted in this imaging study being performed."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.modality" 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)."><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 href="imaging-modality.html" style="color: navy">All series.modality if actual acquisition modalities</a></span><span style="color: Gray"> --></span> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.referrer" title="The requesting/referring physician."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.availability" title="Availability of study (online, offline or nearline)."><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 href="instance-availability.html" style="color: navy">ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056)</a></span><span style="color: Gray"> --></span> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.url" title="WADO-RS URI where Study is available."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.numberOfSeries" title="Number of Series in Study."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.numberOfInstances" title="Number of SOP Instances in Study."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.clinicalInformation" title="Diagnoses etc provided with request."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.procedure" title="Type of procedure performed."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.interpreter" title="Who read study and interpreted the images."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.description" title="Institution-generated description or classification of the Study (component) performed."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series" title="Each study has one or more series of image instances."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series.number" title="The number of this series in the overall sequence."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series.modality" title="The modality of this series sequence."><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 href="modality.html" style="color: navy">The modality of the instances in the series (0008,0060)</a></span><span style="color: Gray"> --></span> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series.uid" title="Formal identifier for this series."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series.description" title="A description of the series."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series.numberOfInstances" title="Sequence that contains attributes from the."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series.availability" title="Availability of series (online, offline or nearline)."><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 href="instance-availability.html" style="color: navy">ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056)</a></span><span style="color: Gray"> --></span> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series.url" title="WADO-RS URI where Series is available."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series.bodySite" title="Body part examined. See DICOM Part 16 Annex L for the mapping from DICOM to Snomed."><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 href="valueset-body-site.html" style="color: navy">Body part examined (Map from 0018,0015)</a></span><span style="color: Gray"> --></span></bodySite> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series.dateTime" title="When the series started."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series.instance" title="A single image taken from a patient."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series.instance.number" title="The number of this image in the series."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series.instance.uid" title="Formal identifier for this image."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series.instance.sopclass" title="DICOM Image type."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series.instance.type" title="Type of instance (image etc) (0004,1430)."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series.instance.title" title="Description (0070,0080 | 0040,A043 > 0008,0104 | 0042,0010 | 0008,0008)."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series.instance.url" title="WADO-RS url where image is available."><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> <<a class="dict" href="imagingstudy-definitions.html#ImagingStudy.series.instance.attachment" title="A FHIR resource with content for this instance."><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> </instance> </series> </ImagingStudy> </pre></div> </summary> </entry> <entry> <title>"immunization" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/immunization</id> <link href="http://hl7.org/implement/standards/fhir/immunization.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="immunization-definitions.html#Immunization" title="Immunization event information."><b>Immunization</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="immunization-definitions.html#Immunization.identifier" title="A unique identifier assigned to this adverse reaction record."><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> <<a class="dict" href="immunization-definitions.html#Immunization.date" title="Date vaccine administered or was to be administered."><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> <<a class="dict" href="immunization-definitions.html#Immunization.vaccineType" title="Vaccine that was administered or was to be administered."><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 href="v3/vs/VaccineType/index.html" style="color: navy">Vaccine product administered</a><span style="color: Gray"> --></span></vaccineType> <<a class="dict" href="immunization-definitions.html#Immunization.subject" title="The patient to whom the vaccine was to be administered."><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> <<a class="dict" href="immunization-definitions.html#Immunization.refusedIndicator" title="Indicates if the vaccination was refused."><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> <<a class="dict" href="immunization-definitions.html#Immunization.reported" title="True if this administration was reported rather than directly administered."><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> <<a class="dict" href="immunization-definitions.html#Immunization.performer" title="Clinician who administered the vaccine."><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> <<a class="dict" href="immunization-definitions.html#Immunization.requester" title="Clinician who ordered the vaccination."><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> <<a class="dict" href="immunization-definitions.html#Immunization.manufacturer" title="Name of vaccine 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> <<a class="dict" href="immunization-definitions.html#Immunization.location" title="The service delivery location where the vaccine administration occurred."><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> <<a class="dict" href="immunization-definitions.html#Immunization.lotNumber" title="Lot number of the vaccine product."><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> <<a class="dict" href="immunization-definitions.html#Immunization.expirationDate" title="Date vaccine batch expires."><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> <<a class="dict" href="immunization-definitions.html#Immunization.site" title="Body site where vaccine was administered."><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 href="valueset-immunization-site.html" style="color: navy">Body site vaccine was administered</a></span><span style="color: Gray"> --></span></site> <<a class="dict" href="immunization-definitions.html#Immunization.route" title="The path by which the vaccine product is taken into the body."><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 href="valueset-immunization-route.html" style="color: navy">How vaccine entered body</a></span><span style="color: Gray"> --></span></route> <<a class="dict" href="immunization-definitions.html#Immunization.doseQuantity" title="The quantity of vaccine product that was administered."><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> <<a class="dict" href="immunization-definitions.html#Immunization.explanation" title="Reasons why a vaccine was administered or refused."><b>explanation</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..1</b></span> Administration / refusal reasons --></span> <<a class="dict" href="immunization-definitions.html#Immunization.explanation.reason" title="Reasons why a vaccine was administered."><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 href="valueset-immunization-reason.html" style="color: navy">Why immunization occurred</a></span><span style="color: Gray"> --></span></reason> <<a class="dict" href="immunization-definitions.html#Immunization.explanation.refusalReason" title="Refusal or exemption reasons."><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 href="valueset-no-immunization-reason.html" style="color: navy">Why immunization did not occur</a></span><span style="color: Gray"> --></span></refusalReason> </explanation> <<a class="dict" href="immunization-definitions.html#Immunization.reaction" title="Categorical data indicating that an adverse event is associated in time to an immunization."><b>reaction</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Details of a reaction that follows immunization --></span> <<a class="dict" href="immunization-definitions.html#Immunization.reaction.date" title="Date of reaction to the immunization."><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> <<a class="dict" href="immunization-definitions.html#Immunization.reaction.detail" title="Details of the reaction."><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> <<a class="dict" href="immunization-definitions.html#Immunization.reaction.reported" title="Self-reported indicator."><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> </reaction> <<a class="dict" href="immunization-definitions.html#Immunization.vaccinationProtocol" title="Contains information about the protocol(s) under which the vaccine was administered."><b>vaccinationProtocol</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> What protocol was followed --></span> <<a class="dict" href="immunization-definitions.html#Immunization.vaccinationProtocol.doseSequence" title="Nominal position in a series."><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> <<a class="dict" href="immunization-definitions.html#Immunization.vaccinationProtocol.description" title="Contains the description about the protocol under which the vaccine was administered."><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> <<a class="dict" href="immunization-definitions.html#Immunization.vaccinationProtocol.authority" title="Indicates the authority who published the protocol? E.g. ACIP."><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> <<a class="dict" href="immunization-definitions.html#Immunization.vaccinationProtocol.series" title="One possible path to achieve presumed immunity against a disease - within the context of an authority."><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> <<a class="dict" href="immunization-definitions.html#Immunization.vaccinationProtocol.seriesDoses" title="The recommended number of doses to achieve immunity."><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> <<a class="dict" href="immunization-definitions.html#Immunization.vaccinationProtocol.doseTarget" title="The targeted disease."><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 href="valueset-vaccination-protocol-dose-target.html" style="color: navy">Disease immunized against</a></span><span style="color: Gray"> --></span></doseTarget> <<a class="dict" href="immunization-definitions.html#Immunization.vaccinationProtocol.doseStatus" title="Indicates if the immunization event should "count" against the protocol."><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 href="valueset-vaccination-protocol-dose-status.html" style="color: navy">Does dose count towards immunity?</a></span><span style="color: Gray"> --></span></doseStatus> <<a class="dict" href="immunization-definitions.html#Immunization.vaccinationProtocol.doseStatusReason" title="Provides an explanation as to why a immunization event should or should not count against the protocol."><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 href="valueset-vaccination-protocol-dose-status-reason.html" style="color: navy">Why does does count/not count?</a></span><span style="color: Gray"> --></span></doseStatusReason> </vaccinationProtocol> </Immunization> </pre></div> </text> <name value="immunization"/> <publisher value="FHIR Project"/> <description value="Basic Profile. Immunization event information."/> <status value="draft"/> <date value="2014-09-30"/> <requirements value="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. Additionally, 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 value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <mapping> <identity value="cda"/> <uri value="http://hl7.org/v3/cda"/> <name value="CDA (R2)"/> </mapping> <structure> <type value="Immunization"/> <publish value="true"/> <element> <path value="Immunization"/> <definition> <short value="Immunization event information"/> <formal value="Immunization event information."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="SubstanceAdministration"/> </mapping> <mapping> <identity value="v2"/> <map value="VXU_V04"/> </mapping> </definition> </element> <element> <path value="Immunization.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Immunization.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Immunization.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Immunization.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Immunization.identifier"/> <definition> <short value="Business identifier"/> <formal value="A unique identifier assigned to this adverse reaction record."/> <min value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> <mapping> <identity value="cda"/> <map value="ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id"/> </mapping> </definition> </element> <element> <path value="Immunization.date"/> <definition> <short value="Vaccination administration date"/> <formal value="Date vaccine administered or was to be administered."/> <min value="1"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".effectiveTime"/> </mapping> <mapping> <identity value="cda"/> <map value="ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveT ime/value"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-3-date/time start of administration"/> </mapping> </definition> </element> <element> <path value="Immunization.vaccineType"/> <definition> <short value="Vaccine product administered"/> <formal value="Vaccine that was administered or was to be administered."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="VaccineType"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/v3/vs/VaccineType"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> <mapping> <identity value="cda"/> <map value="ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable /manfacturedProduct/manufacturedMaterial/realmCode/code"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-5-administered code"/> </mapping> </definition> </element> <element> <path value="Immunization.subject"/> <definition> <short value="Who was immunized?"/> <formal value="The patient to whom the vaccine was to be administered."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".partipication[ttypeCode=].role"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-3-patient ID list"/> </mapping> </definition> </element> <element> <path value="Immunization.refusedIndicator"/> <definition> <short value="Was immunization refused?"/> <formal value="Indicates if the vaccination was refused."/> <min value="1"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="[actionNegationInd=true].reasonCode"/> </mapping> </definition> </element> <element> <path value="Immunization.reported"/> <definition> <short value="Is this a self-reported record?"/> <formal value="True if this administration was reported rather than directly administered."/> <comments value="May need source of reported info (e.g. parent), but leave out for now."/> <min value="1"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-9"/> </mapping> </definition> </element> <element> <path value="Immunization.performer"/> <definition> <short value="Who administered vaccine?"/> <formal value="Clinician who administered the vaccine."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=PRF].COCT_MT090102UV"/> </mapping> <mapping> <identity value="cda"/> <map value="ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/performer/ assignedEntity/assignedPerson/name"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-10-administering provider"/> </mapping> </definition> </element> <element> <path value="Immunization.requester"/> <definition> <short value="Who ordered vaccination?"/> <formal value="Clinician who ordered the vaccination."/> <comments value="Other participants - delegate to Provenance resource."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="outboundRelationship.target[classCode=SBADM].participation[typeCode=AUT].COCT_MT090102UV"/> </mapping> <mapping> <identity value="v2"/> <map value="ORC-12-ordering provider"/> </mapping> </definition> </element> <element> <path value="Immunization.manufacturer"/> <definition> <short value="Vaccine manufacturer"/> <formal value="Name of vaccine manufacturer."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Organization"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]"/> </mapping> <mapping> <identity value="cda"/> <map value="ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable /manfacturedProduct/manufacuturerOrganization/name"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-17-substance manufacturer name"/> </mapping> </definition> </element> <element> <path value="Immunization.location"/> <definition> <short value="Where did vaccination occur?"/> <formal value="The service delivery location where the vaccine administration occurred."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Location"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=LOC].COCT_MT240000UV"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-27-administered-at (or RXA-11-administered-at location, deprecated as of v2.7)"/> </mapping> </definition> </element> <element> <path value="Immunization.lotNumber"/> <definition> <short value="Vaccine lot number"/> <formal value="Lot number of the vaccine product."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id"/> </mapping> <mapping> <identity value="cda"/> <map value="ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable /manfacturedProduct/manufacturedMaterial/lotNumberText"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-15-substance lot number"/> </mapping> </definition> </element> <element> <path value="Immunization.expirationDate"/> <definition> <short value="Vaccine expiration date"/> <formal value="Date vaccine batch expires."/> <min value="0"/> <max value="1"/> <type> <code value="date"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-16-substance expiration date"/> </mapping> </definition> </element> <element> <path value="Immunization.site"/> <definition> <short value="Body site vaccine was administered"/> <formal value="Body site where vaccine was administered."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="ImmunizationSite"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/immunization-site"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="observation.targetSiteCode"/> </mapping> <mapping> <identity value="cda"/> <map value="ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSi teCode/code"/> </mapping> <mapping> <identity value="v2"/> <map value="RXR-2-administration site"/> </mapping> </definition> </element> <element> <path value="Immunization.route"/> <definition> <short value="How vaccine entered body"/> <formal value="The path by which the vaccine product is taken into the body."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="ImmunizationRoute"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/immunization-route"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".routeCode"/> </mapping> <mapping> <identity value="cda"/> <map value="ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/ code"/> </mapping> <mapping> <identity value="v2"/> <map value="RXR-1-route"/> </mapping> </definition> </element> <element> <path value="Immunization.doseQuantity"/> <definition> <short value="Amount of vaccine administered"/> <formal value="The quantity of vaccine product that was administered."/> <min value="0"/> <max value="1"/> <type> <code value="Quantity"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".doseQuantity"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-6-administered amount / RXA-7.1-administered units.code"/> </mapping> </definition> </element> <element> <path value="Immunization.explanation"/> <definition> <short value="Administration / refusal reasons"/> <formal value="Reasons why a vaccine was administered or refused."/> <min value="0"/> <max value="1"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </definition> </element> <element> <path value="Immunization.explanation.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Immunization.explanation.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Immunization.explanation.reason"/> <definition> <short value="Why immunization occurred"/> <formal value="Reasons why a vaccine was administered."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="ImmunizationReason"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/immunization-reason"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="[actionNegationInd=false].reasonCode"/> </mapping> </definition> </element> <element> <path value="Immunization.explanation.refusalReason"/> <definition> <short value="Why immunization did not occur"/> <formal value="Refusal or exemption reasons."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="NoImmunizationReason"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/no-immunization-reason"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="[actionNegationInd=true].reasonCode"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-18"/> </mapping> </definition> </element> <element> <path value="Immunization.reaction"/> <definition> <short value="Details of a reaction that follows immunization"/> <formal value="Categorical data indicating that an adverse event is associated in time to an immunization."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Observation[classCode=obs].code"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-3"/> </mapping> </definition> </element> <element> <path value="Immunization.reaction.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Immunization.reaction.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Immunization.reaction.date"/> <definition> <short value="When did reaction start?"/> <formal value="Date of reaction to the immunization."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".effectiveTime"/> </mapping> <mapping> <identity value="v2"/> <map value="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 )"/> </mapping> </definition> </element> <element> <path value="Immunization.reaction.detail"/> <definition> <short value="Additional information on reaction"/> <formal value="Details of the reaction."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/AdverseReaction"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Observation"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".value"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-5"/> </mapping> </definition> </element> <element> <path value="Immunization.reaction.reported"/> <definition> <short value="Was reaction self-reported?"/> <formal value="Self-reported indicator."/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)"/> </mapping> <mapping> <identity value="v2"/> <map value="(no such concept seems to exist for allergy/adverse reaction in V2.x)"/> </mapping> </definition> </element> <element> <path value="Immunization.vaccinationProtocol"/> <definition> <short value="What protocol was followed"/> <formal value="Contains information about the protocol(s) under which the vaccine was administered."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="outboundRelationship[typeCode=INST].target[classCode=SBADM]"/> </mapping> <mapping> <identity value="v2"/> <map value="(V2.x doesn't seem to provide for this)"/> </mapping> </definition> </element> <element> <path value="Immunization.vaccinationProtocol.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Immunization.vaccinationProtocol.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Immunization.vaccinationProtocol.doseSequence"/> <definition> <short value="What dose number within series?"/> <formal value="Nominal position in a series."/> <min value="1"/> <max value="1"/> <type> <code value="integer"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].seque nceNumber"/> </mapping> </definition> </element> <element> <path value="Immunization.vaccinationProtocol.description"/> <definition> <short value="Details of vaccine protocol"/> <formal value="Contains the description about the protocol under which the vaccine was administered."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].sourc e[classCode=SBADM].text"/> </mapping> </definition> </element> <element> <path value="Immunization.vaccinationProtocol.authority"/> <definition> <short value="Who is responsible for protocol"/> <formal value="Indicates the authority who published the protocol? E.g. ACIP."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Organization"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].sourc e[classCode=SBADM].participation[typeCode=AUT].COCT_MT090200UV"/> </mapping> </definition> </element> <element> <path value="Immunization.vaccinationProtocol.series"/> <definition> <short value="Name of vaccine series"/> <formal value="One possible path to achieve presumed immunity against a disease - within the context of an authority."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="outboundRelationship[typeCode=INST].target[classCode=SBADM]"/> </mapping> </definition> </element> <element> <path value="Immunization.vaccinationProtocol.seriesDoses"/> <definition> <short value="Recommended number of doses for immunity"/> <formal value="The recommended number of doses to achieve immunity."/> <min value="0"/> <max value="1"/> <type> <code value="integer"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].sourc e[classCode=SBADM].text"/> </mapping> </definition> </element> <element> <path value="Immunization.vaccinationProtocol.doseTarget"/> <definition> <short value="Disease immunized against"/> <formal value="The targeted disease."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="VaccinationProtocolDoseTarget"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/vaccination-protocol-dose-target"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="outboundRelationship.target[classCode=OBS].code"/> </mapping> </definition> </element> <element> <path value="Immunization.vaccinationProtocol.doseStatus"/> <definition> <short value="Does dose count towards immunity?"/> <formal value="Indicates if the immunization event should "count" against the protocol."/> <comments value="May need to differentiate between status declarations by a provider vs. a CDS engine."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="VaccinationProtocolDoseStatus"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/vaccination-protocol-dose-status"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].playedRole[class Code=INGR].scopedRole.scoper[classCode=MMAT].playedRole[classCode=HLTHCHRT].participation[typeCode=SB J].observation[classCode=OBS].value"/> </mapping> </definition> </element> <element> <path value="Immunization.vaccinationProtocol.doseStatusReason"/> <definition> <short value="Why does does count/not count?"/> <formal value="Provides an explanation as to why a immunization event should or should not count against the protocol."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="VaccinationProtocolDoseStatusReason"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/vaccination-protocol-dose-status-reason"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].playedRole[class Code=INGR].scopedRole.scoper[classCode=MMAT].playedRole[classCode=HLTHCHRT].participation[typeCode=SB J].observation[classCode=OBS].reasonCode"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="date"/> <type value="date"/> <documentation value="Vaccination Administration / Refusal Date"/> <xpath value="f:Immunization/f:date"/> </searchParam> <searchParam> <name value="dose-sequence"/> <type value="number"/> <documentation value="What dose number within series?"/> <xpath value="f:Immunization/f:vaccinationProtocol/f:doseSequence"/> </searchParam> <searchParam> <name value="identifier"/> <type value="token"/> <documentation value="Business identifier"/> <xpath value="f:Immunization/f:identifier"/> </searchParam> <searchParam> <name value="location"/> <type value="reference"/> <documentation value="The service delivery location or facility in which the vaccine was / was to be administered"/> <xpath value="f:Immunization/f:location"/> </searchParam> <searchParam> <name value="lot-number"/> <type value="string"/> <documentation value="Vaccine Lot Number"/> <xpath value="f:Immunization/f:lotNumber"/> </searchParam> <searchParam> <name value="manufacturer"/> <type value="reference"/> <documentation value="Vaccine Manufacturer"/> <xpath value="f:Immunization/f:manufacturer"/> </searchParam> <searchParam> <name value="performer"/> <type value="reference"/> <documentation value="The practitioner who administered the vaccination"/> <xpath value="f:Immunization/f:performer"/> </searchParam> <searchParam> <name value="reaction"/> <type value="reference"/> <documentation value="Additional information on reaction"/> <xpath value="f:Immunization/f:reaction/f:detail"/> </searchParam> <searchParam> <name value="reaction-date"/> <type value="date"/> <documentation value="When did reaction start?"/> <xpath value="f:Immunization/f:reaction/f:date"/> </searchParam> <searchParam> <name value="reason"/> <type value="token"/> <documentation value="Why immunization occurred"/> <xpath value="f:Immunization/f:explanation/f:reason"/> </searchParam> <searchParam> <name value="refusal-reason"/> <type value="token"/> <documentation value="Explanation of refusal / exemption"/> <xpath value="f:Immunization/f:explanation/f:refusalReason"/> </searchParam> <searchParam> <name value="refused"/> <type value="token"/> <documentation value="Was immunization refused?"/> <xpath value="f:Immunization/f:refusedIndicator"/> </searchParam> <searchParam> <name value="requester"/> <type value="reference"/> <documentation value="The practitioner who ordered the vaccination"/> <xpath value="f:Immunization/f:requester"/> </searchParam> <searchParam> <name value="subject"/> <type value="reference"/> <documentation value="The subject of the vaccination event / refusal"/> <xpath value="f:Immunization/f:subject"/> </searchParam> <searchParam> <name value="vaccine-type"/> <type value="token"/> <documentation value="Vaccine Product Type Administered"/> <xpath value="f:Immunization/f:vaccineType"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="immunization-definitions.html#Immunization" title="Immunization event information."><b>Immunization</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="immunization-definitions.html#Immunization.identifier" title="A unique identifier assigned to this adverse reaction record."><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> <<a class="dict" href="immunization-definitions.html#Immunization.date" title="Date vaccine administered or was to be administered."><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> <<a class="dict" href="immunization-definitions.html#Immunization.vaccineType" title="Vaccine that was administered or was to be administered."><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 href="v3/vs/VaccineType/index.html" style="color: navy">Vaccine product administered</a><span style="color: Gray"> --></span></vaccineType> <<a class="dict" href="immunization-definitions.html#Immunization.subject" title="The patient to whom the vaccine was to be administered."><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> <<a class="dict" href="immunization-definitions.html#Immunization.refusedIndicator" title="Indicates if the vaccination was refused."><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> <<a class="dict" href="immunization-definitions.html#Immunization.reported" title="True if this administration was reported rather than directly administered."><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> <<a class="dict" href="immunization-definitions.html#Immunization.performer" title="Clinician who administered the vaccine."><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> <<a class="dict" href="immunization-definitions.html#Immunization.requester" title="Clinician who ordered the vaccination."><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> <<a class="dict" href="immunization-definitions.html#Immunization.manufacturer" title="Name of vaccine 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> <<a class="dict" href="immunization-definitions.html#Immunization.location" title="The service delivery location where the vaccine administration occurred."><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> <<a class="dict" href="immunization-definitions.html#Immunization.lotNumber" title="Lot number of the vaccine product."><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> <<a class="dict" href="immunization-definitions.html#Immunization.expirationDate" title="Date vaccine batch expires."><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> <<a class="dict" href="immunization-definitions.html#Immunization.site" title="Body site where vaccine was administered."><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 href="valueset-immunization-site.html" style="color: navy">Body site vaccine was administered</a></span><span style="color: Gray"> --></span></site> <<a class="dict" href="immunization-definitions.html#Immunization.route" title="The path by which the vaccine product is taken into the body."><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 href="valueset-immunization-route.html" style="color: navy">How vaccine entered body</a></span><span style="color: Gray"> --></span></route> <<a class="dict" href="immunization-definitions.html#Immunization.doseQuantity" title="The quantity of vaccine product that was administered."><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> <<a class="dict" href="immunization-definitions.html#Immunization.explanation" title="Reasons why a vaccine was administered or refused."><b>explanation</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..1</b></span> Administration / refusal reasons --></span> <<a class="dict" href="immunization-definitions.html#Immunization.explanation.reason" title="Reasons why a vaccine was administered."><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 href="valueset-immunization-reason.html" style="color: navy">Why immunization occurred</a></span><span style="color: Gray"> --></span></reason> <<a class="dict" href="immunization-definitions.html#Immunization.explanation.refusalReason" title="Refusal or exemption reasons."><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 href="valueset-no-immunization-reason.html" style="color: navy">Why immunization did not occur</a></span><span style="color: Gray"> --></span></refusalReason> </explanation> <<a class="dict" href="immunization-definitions.html#Immunization.reaction" title="Categorical data indicating that an adverse event is associated in time to an immunization."><b>reaction</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Details of a reaction that follows immunization --></span> <<a class="dict" href="immunization-definitions.html#Immunization.reaction.date" title="Date of reaction to the immunization."><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> <<a class="dict" href="immunization-definitions.html#Immunization.reaction.detail" title="Details of the reaction."><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> <<a class="dict" href="immunization-definitions.html#Immunization.reaction.reported" title="Self-reported indicator."><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> </reaction> <<a class="dict" href="immunization-definitions.html#Immunization.vaccinationProtocol" title="Contains information about the protocol(s) under which the vaccine was administered."><b>vaccinationProtocol</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> What protocol was followed --></span> <<a class="dict" href="immunization-definitions.html#Immunization.vaccinationProtocol.doseSequence" title="Nominal position in a series."><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> <<a class="dict" href="immunization-definitions.html#Immunization.vaccinationProtocol.description" title="Contains the description about the protocol under which the vaccine was administered."><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> <<a class="dict" href="immunization-definitions.html#Immunization.vaccinationProtocol.authority" title="Indicates the authority who published the protocol? E.g. ACIP."><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> <<a class="dict" href="immunization-definitions.html#Immunization.vaccinationProtocol.series" title="One possible path to achieve presumed immunity against a disease - within the context of an authority."><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> <<a class="dict" href="immunization-definitions.html#Immunization.vaccinationProtocol.seriesDoses" title="The recommended number of doses to achieve immunity."><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> <<a class="dict" href="immunization-definitions.html#Immunization.vaccinationProtocol.doseTarget" title="The targeted disease."><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 href="valueset-vaccination-protocol-dose-target.html" style="color: navy">Disease immunized against</a></span><span style="color: Gray"> --></span></doseTarget> <<a class="dict" href="immunization-definitions.html#Immunization.vaccinationProtocol.doseStatus" title="Indicates if the immunization event should "count" against the protocol."><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 href="valueset-vaccination-protocol-dose-status.html" style="color: navy">Does dose count towards immunity?</a></span><span style="color: Gray"> --></span></doseStatus> <<a class="dict" href="immunization-definitions.html#Immunization.vaccinationProtocol.doseStatusReason" title="Provides an explanation as to why a immunization event should or should not count against the protocol."><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 href="valueset-vaccination-protocol-dose-status-reason.html" style="color: navy">Why does does count/not count?</a></span><span style="color: Gray"> --></span></doseStatusReason> </vaccinationProtocol> </Immunization> </pre></div> </summary> </entry> <entry> <title>"immunizationrecommendation" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/immunizationrecommendation</id> <link href="http://hl7.org/implement/standards/fhir/immunizationrecommendation.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation" title="A patient's point-of-time immunization status and recommendation with optional supporting justification."><b>ImmunizationRecommendation</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation.identifier" title="A unique identifier assigned to this particular recommendation record."><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> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation.subject" title="The patient who is the subject of the profile."><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> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation" title="Vaccine administration recommendations."><b>recommendation</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>1..*</b></span> Vaccine administration recommendations --></span> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.date" title="The date the immunization recommendation was created."><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> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.vaccineType" title="Vaccine that pertains to the recommendation."><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 href="v3/vs/VaccineType/index.html" style="color: navy">Vaccine recommendation applies to</a><span style="color: Gray"> --></span></vaccineType> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.doseNumber" title="This indicates the next recommended dose number (e.g. dose 2 is the next recommended dose)."><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> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.forecastStatus" title="Vaccine administration status."><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 href="valueset-immunization-recommendation-status.html" style="color: navy">Vaccine administration status</a></span><span style="color: Gray"> --></span></forecastStatus> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.dateCriterion" title="Vaccine date recommendations - e.g. earliest date to administer, latest date to administer, etc."><b>dateCriterion</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Dates governing proposed immunization --></span> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.dateCriterion. code" title="Date classification of recommendation - e.g. earliest date to give, latest date to give, etc."><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 href="valueset-immunization-recommendation-date-criterion.html" style="color: navy">Type of date</a></span><span style="color: Gray"> --></span></code> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.dateCriterion. value" title="Date recommendation."><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> </dateCriterion> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.protocol" title="Contains information about the protocol under which the vaccine was administered."><b>protocol</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..1</b></span> Protocol used by recommendation --></span> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.protocol.doseS equence" title="Indicates the nominal position in a series of the next dose. This is the recommended dose number as per a specified protocol."><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> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.protocol.descr iption" title="Contains the description about the protocol under which the vaccine was administered."><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> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.protocol.autho rity" title="Indicates the authority who published the protocol? E.g. ACIP."><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> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.protocol.serie s" title="One possible path to achieve presumed immunity against a disease - within the context of an authority."><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> </protocol> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.supportingImmu nization" title="Immunization event history that supports the status and recommendation."><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"> Past immunizations supporting recommendation</span><span style="color: Gray"> --></span></supportingImmunization> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.supportingPati entInformation" title="Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information."><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>| <a href="allergyintolerance.html#AllergyIntolerance">AllergyIntolerance</a>)</span> <span style="color: navy">Patient observations supporting recommendation</span><span style="color: Gray"> --></span></supportingPatientInformation> </recommendation> </ImmunizationRecommendation> </pre></div> </text> <name value="immunizationrecommendation"/> <publisher value="FHIR Project"/> <description value="Basic Profile. A patient's point-of-time immunization status and recommendation with optional supporting justification."/> <status value="draft"/> <date value="2014-09-30"/> <requirements value="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. Additionally, 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 value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <structure> <type value="ImmunizationRecommendation"/> <publish value="true"/> <element> <path value="ImmunizationRecommendation"/> <definition> <short value="Immunization profile"/> <formal value="A patient's point-of-time immunization status and recommendation with optional supporting justification."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="SubstanceAdministration[moodCode=RMD]"/> </mapping> <mapping> <identity value="v2"/> <map value="VXU_V04"/> </mapping> </definition> </element> <element> <path value="ImmunizationRecommendation.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ImmunizationRecommendation.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ImmunizationRecommendation.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ImmunizationRecommendation.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ImmunizationRecommendation.identifier"/> <definition> <short value="Business identifier"/> <formal value="A unique identifier assigned to this particular recommendation record."/> <min value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> </definition> </element> <element> <path value="ImmunizationRecommendation.subject"/> <definition> <short value="Who this profile is for"/> <formal value="The patient who is the subject of the profile."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".partipication[typeCode=SUBJ].role"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-3-patient ID list"/> </mapping> </definition> </element> <element> <path value="ImmunizationRecommendation.recommendation"/> <definition> <short value="Vaccine administration recommendations"/> <formal value="Vaccine administration recommendations."/> <min value="1"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode='COMP'].target[classCode=SBADM, moodCode=RMD]"/> </mapping> </definition> </element> <element> <path value="ImmunizationRecommendation.recommendation.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ImmunizationRecommendation.recommendation.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ImmunizationRecommendation.recommendation.date"/> <definition> <short value="Date recommendation created"/> <formal value="The date the immunization recommendation was created."/> <min value="1"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".partipication[typeCode=AUTH].time"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-15-date/time of the observation"/> </mapping> </definition> </element> <element> <path value="ImmunizationRecommendation.recommendation.vaccineType"/> <definition> <short value="Vaccine recommendation applies to"/> <formal value="Vaccine that pertains to the recommendation."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="VaccineType"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/v3/vs/VaccineType"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".partipication[typeCode=CSM].role[classCode=ADMM].code"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-5-observation value : OBX-3-observation identifier e { 30956-7 | 38890-0 }"/> </mapping> </definition> </element> <element> <path value="ImmunizationRecommendation.recommendation.doseNumber"/> <definition> <short value="Recommended dose number"/> <formal value="This indicates the next recommended dose number (e.g. dose 2 is the next recommended dose)."/> <comments value="May need other dose concepts such as administered vs. valid."/> <min value="0"/> <max value="1"/> <type> <code value="integer"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=COMP, .source[classCode=SBADM, moodCode=INT]].sequenceNumber"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-5-observation value : OBX-3-observation identifier = 30973-2"/> </mapping> </definition> </element> <element> <path value="ImmunizationRecommendation.recommendation.forecastStatus"/> <definition> <short value="Vaccine administration status"/> <formal value="Vaccine administration status."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="ImmunizationRecommendationStatus"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/immunization-recommendation-status"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=SUBJ] .source[classCode=OBS, moodCode=EVN, code="Immunization Forecast Status"].value"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-5-observation value : OBX-3-observation identifier = 59783-1"/> </mapping> </definition> </element> <element> <path value="ImmunizationRecommendation.recommendation.dateCriterion"/> <definition> <short value="Dates governing proposed immunization"/> <formal value="Vaccine date recommendations - e.g. earliest date to administer, latest date to administer, etc."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode='LIMIT'].target[classCode=OBS, moodCode=EVN, isCriterionInd=true]"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-3: 30980-7 = Next dose recommended, 59777-3 = Latest next dose should be given, 59778-1 = Dose is overdue"/> </mapping> </definition> </element> <element> <path value="ImmunizationRecommendation.recommendation.dateCriterion.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ImmunizationRecommendation.recommendation.dateCriterion.code"/> <definition> <short value="Type of date"/> <formal value="Date classification of recommendation - e.g. earliest date to give, latest date to give, etc."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="ImmunizationRecommendationDateCriterion"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/immunization-recommendation-date-criterion"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-3-observation identifier"/> </mapping> </definition> </element> <element> <path value="ImmunizationRecommendation.recommendation.dateCriterion.value"/> <definition> <short value="Recommended date"/> <formal value="Date recommendation."/> <min value="1"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".value"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-5-observation value"/> </mapping> </definition> </element> <element> <path value="ImmunizationRecommendation.recommendation.protocol"/> <definition> <short value="Protocol used by recommendation"/> <formal value="Contains information about the protocol under which the vaccine was administered."/> <min value="0"/> <max value="1"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=INST].source[classCode=SBADM, moodCode=DEF]"/> </mapping> </definition> </element> <element> <path value="ImmunizationRecommendation.recommendation.protocol.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ImmunizationRecommendation.recommendation.protocol.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="ImmunizationRecommendation.recommendation.protocol.doseSequence"/> <definition> <short value="Number of dose within sequence"/> <formal value="Indicates the nominal position in a series of the next dose. This is the recommended dose number as per a specified protocol."/> <min value="0"/> <max value="1"/> <type> <code value="integer"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=COMP, .source[classCode=SBADM, moodCode=DEF]].sequenceNumber"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-5-observation value : OBX-3-observation identifier = 30973-2"/> </mapping> </definition> </element> <element> <path value="ImmunizationRecommendation.recommendation.protocol.description"/> <definition> <short value="Protocol details"/> <formal value="Contains the description about the protocol under which the vaccine was administered."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".text"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-5-observation value : OBX-3-observation identifier = 30956-7"/> </mapping> </definition> </element> <element> <path value="ImmunizationRecommendation.recommendation.protocol.authority"/> <definition> <short value="Who is responsible for protocol"/> <formal value="Indicates the authority who published the protocol? E.g. ACIP."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Organization"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=AUT]"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-5-observation value : OBX-3-observation identifier = 59779-9"/> </mapping> </definition> </element> <element> <path value="ImmunizationRecommendation.recommendation.protocol.series"/> <definition> <short value="Name of vaccination series"/> <formal value="One possible path to achieve presumed immunity against a disease - within the context of an authority."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".title"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-5-administered code"/> </mapping> </definition> </element> <element> <path value="ImmunizationRecommendation.recommendation.supportingImmunization"/> <definition> <short value="Past immunizations supporting recommendation"/> <formal value="Immunization event history that supports the status and recommendation."/> <min value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Immunization"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=RSON].target[classCode=SBADM, moodCode=EVN, code="immunization&q uot;]"/> </mapping> <mapping> <identity value="v2"/> <map value="? No clear way to associate in V2.x or IG"/> </mapping> </definition> </element> <element> <path value="ImmunizationRecommendation.recommendation.supportingPatientInformation"/> <definition> <short value="Patient observations supporting recommendation"/> <formal value="Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information."/> <min value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Observation"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/AdverseReaction"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/AllergyIntolerance"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=RSON].target[classCode=OBS, moodCode=EVN]"/> </mapping> <mapping> <identity value="v2"/> <map value="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"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="date"/> <type value="date"/> <documentation value="Date recommendation created"/> <xpath value="f:ImmunizationRecommendation/f:recommendation/f:date"/> </searchParam> <searchParam> <name value="dose-number"/> <type value="number"/> <documentation value="Recommended dose number"/> <xpath value="f:ImmunizationRecommendation/f:recommendation/f:doseNumber"/> </searchParam> <searchParam> <name value="dose-sequence"/> <type value="token"/> <documentation value="Number of dose within sequence"/> <xpath value="f:ImmunizationRecommendation/f:recommendation/f:protocol/f:doseSequence"/> </searchParam> <searchParam> <name value="identifier"/> <type value="token"/> <documentation value="Business identifier"/> <xpath value="f:ImmunizationRecommendation/f:identifier"/> </searchParam> <searchParam> <name value="information"/> <type value="reference"/> <documentation value="Patient observations supporting recommendation"/> <xpath value="f:ImmunizationRecommendation/f:recommendation/f:supportingPatientInformation"/> </searchParam> <searchParam> <name value="status"/> <type value="token"/> <documentation value="Vaccine administration status"/> <xpath value="f:ImmunizationRecommendation/f:recommendation/f:forecastStatus"/> </searchParam> <searchParam> <name value="subject"/> <type value="reference"/> <documentation value="Who this profile is for"/> <xpath value="f:ImmunizationRecommendation/f:subject"/> </searchParam> <searchParam> <name value="support"/> <type value="reference"/> <documentation value="Past immunizations supporting recommendation"/> <xpath value="f:ImmunizationRecommendation/f:recommendation/f:supportingImmunization"/> </searchParam> <searchParam> <name value="vaccine-type"/> <type value="token"/> <documentation value="Vaccine recommendation applies to"/> <xpath value="f:ImmunizationRecommendation/f:recommendation/f:vaccineType"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation" title="A patient's point-of-time immunization status and recommendation with optional supporting justification."><b>ImmunizationRecommendation</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation.identifier" title="A unique identifier assigned to this particular recommendation record."><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> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation.subject" title="The patient who is the subject of the profile."><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> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation" title="Vaccine administration recommendations."><b>recommendation</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>1..*</b></span> Vaccine administration recommendations --></span> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.date" title="The date the immunization recommendation was created."><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> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.vaccineType" title="Vaccine that pertains to the recommendation."><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 href="v3/vs/VaccineType/index.html" style="color: navy">Vaccine recommendation applies to</a><span style="color: Gray"> --></span></vaccineType> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.doseNumber" title="This indicates the next recommended dose number (e.g. dose 2 is the next recommended dose)."><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> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.forecastStatus" title="Vaccine administration status."><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 href="valueset-immunization-recommendation-status.html" style="color: navy">Vaccine administration status</a></span><span style="color: Gray"> --></span></forecastStatus> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.dateCriterion" title="Vaccine date recommendations - e.g. earliest date to administer, latest date to administer, etc."><b>dateCriterion</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Dates governing proposed immunization --></span> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.dateCriterion. code" title="Date classification of recommendation - e.g. earliest date to give, latest date to give, etc."><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 href="valueset-immunization-recommendation-date-criterion.html" style="color: navy">Type of date</a></span><span style="color: Gray"> --></span></code> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.dateCriterion. value" title="Date recommendation."><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> </dateCriterion> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.protocol" title="Contains information about the protocol under which the vaccine was administered."><b>protocol</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..1</b></span> Protocol used by recommendation --></span> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.protocol.doseS equence" title="Indicates the nominal position in a series of the next dose. This is the recommended dose number as per a specified protocol."><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> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.protocol.descr iption" title="Contains the description about the protocol under which the vaccine was administered."><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> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.protocol.autho rity" title="Indicates the authority who published the protocol? E.g. ACIP."><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> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.protocol.serie s" title="One possible path to achieve presumed immunity against a disease - within the context of an authority."><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> </protocol> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.supportingImmu nization" title="Immunization event history that supports the status and recommendation."><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"> Past immunizations supporting recommendation</span><span style="color: Gray"> --></span></supportingImmunization> <<a class="dict" href="immunizationrecommendation-definitions.html#ImmunizationRecommendation.recommendation.supportingPati entInformation" title="Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information."><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>| <a href="allergyintolerance.html#AllergyIntolerance">AllergyIntolerance</a>)</span> <span style="color: navy">Patient observations supporting recommendation</span><span style="color: Gray"> --></span></supportingPatientInformation> </recommendation> </ImmunizationRecommendation> </pre></div> </summary> </entry> <entry> <title>"list" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/list</id> <link href="http://hl7.org/implement/standards/fhir/list.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="list-definitions.html#List" title="A set of information summarized from a list of other resources."><b>List</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="list-definitions.html#List.identifier" title="Identifier for the List assigned for business purposes outside the context of FHIR."><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> <<a class="dict" href="list-definitions.html#List.code" title="This code defines the purpose of the list - why it was created."><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 href="valueset-list-example-codes.html" style="color: navy">What the purpose of this list is</a></span><span style="color: Gray"> --></span></code> <<a class="dict" href="list-definitions.html#List.subject" title="The common subject (or patient) of the resources that are in the list, if there is one."><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"> If all resources have the same subject</span><span style="color: Gray"> --></span></subject> <<a class="dict" href="list-definitions.html#List.source" title="The entity responsible for deciding what the contents of the list were."><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"> Who and/or what defined the list contents</span><span style="color: Gray"> --></span></source> <<a class="dict" href="list-definitions.html#List.date" title="The date that the list was prepared."><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> <<a class="dict" href="list-definitions.html#List.ordered" title="Whether items in the list have a meaningful order (this element modifies the meaning of other elements)"><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> <<a class="dict" href="list-definitions.html#List.mode" 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)"><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 href="list-mode.html" style="color: navy">working | snapshot | changes</a></span><span style="color: Gray"> --></span> <<a class="dict" href="list-definitions.html#List.entry" title="Entries in this list."><b>entry</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-1: A list can only have an emptyReason if it is empty"><b><img alt="??" src="lock.png"/> 0..*</b></span> Entries in the list --></span> <<a class="dict" href="list-definitions.html#List.entry.flag" 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."><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 href="valueset-list-item-flag.html" style="color: navy">Workflow information about this item</a></span><span style="color: Gray"> --></span></flag> <<a class="dict" href="list-definitions.html#List.entry.deleted" title="True if this item is marked as deleted in the list (this element modifies the meaning of other elements)"><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 style="color: brown" title="Inv-2: The deleted flag can only be used if the mode of the list is "changes""><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> <<a class="dict" href="list-definitions.html#List.entry.date" title="When this item was added to the list."><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> <<a class="dict" href="list-definitions.html#List.entry.item" title="A reference to the actual resource from which data was derived."><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> </entry> <<a class="dict" href="list-definitions.html#List.emptyReason" title="If the list is empty, why the list is empty."><b>emptyReason</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: A list can only have an emptyReason if it is empty"><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 href="valueset-list-empty-reason.html" style="color: navy">Why list is empty</a></span><span style="color: Gray"> --></span></emptyReason> </List> </pre></div> </text> <name value="list"/> <publisher value="FHIR Project"/> <description value="Basic Profile. A set of information summarized from a list of other resources."/> <status value="draft"/> <date value="2014-09-30"/> <requirements value="Scope and Usage List resources are used in many places, including allergies, medications, alerts, medical history, etc."/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <structure> <type value="List"/> <publish value="true"/> <element> <path value="List"/> <definition> <short value="Information summarized from a list of other resources"/> <formal value="A set of information summarized from a list of other resources."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <constraint> <key value="2"/> <name value="Deleted Rule"/> <severity value="error"/> <human value="The deleted flag can only be used if the mode of the list is "changes""/> <xpath value="(f:mode/@value = 'changes') or not(exists(f:entry/f:item/f:deleted))"/> </constraint> <constraint> <key value="1"/> <name value="No emptyReason if list is not empty"/> <severity value="error"/> <human value="A list can only have an emptyReason if it is empty"/> <xpath value="not(exists(f:emptyReason) and exists(f:entry))"/> </constraint> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Act[classCode<ORG,moodCode=EVN]"/> </mapping> </definition> </element> <element> <path value="List.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="List.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="List.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="List.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="List.identifier"/> <definition> <short value="Business identifier"/> <formal value="Identifier for the List assigned for business purposes outside the context of FHIR."/> <min value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> </definition> </element> <element> <path value="List.code"/> <definition> <short value="What the purpose of this list is"/> <formal value="This code defines the purpose of the list - why it was created."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="ListPurpose"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/list-example-codes"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> </definition> </element> <element> <path value="List.subject"/> <definition> <short value="If all resources have the same subject"/> <formal value="The common subject (or patient) of the resources that are in the list, if there is one."/> <comments value="Some purely aribitrary lists do not have a common subject, so this is optional."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Group"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Device"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Location"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode<SUB].role (and sometimes .player)"/> </mapping> </definition> </element> <element> <path value="List.source"/> <definition> <short value="Who and/or what defined the list contents"/> <formal value="The entity responsible for deciding what the contents of the list were."/> <comments value="The primary source is the entity that made the decisions what items are in the list. This may be software or user."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Device"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode<AUT].role[classCode=REL].player[classCode=PSN,determinerCode=INST] or .participation[typeCode<AUT].role[classCode=REL].player[classCode=DEV,determinerCode=INST]"/> </mapping> </definition> </element> <element> <path value="List.date"/> <definition> <short value="When the list was prepared"/> <formal value="The date that the list was prepared."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode<AUT].time[type=TS]"/> </mapping> </definition> </element> <element> <path value="List.ordered"/> <definition> <short value="Whether items in the list have a meaningful order"/> <formal value="Whether items in the list have a meaningful order."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=COMP].sequenceNumber > 1"/> </mapping> </definition> </element> <element> <path value="List.mode"/> <definition> <short value="working | snapshot | changes"/> <formal value="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 value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="ListMode"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/list-mode"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value"/> </mapping> </definition> </element> <element> <path value="List.entry"/> <definition> <short value="Entries in the list"/> <formal value="Entries in this list."/> <comments value="If there are no entries in the list, an emptyReason SHOULD be provided."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]"/> </mapping> </definition> </element> <element> <path value="List.entry.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="List.entry.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="List.entry.flag"/> <definition> <short value="Workflow information about this item"/> <formal value="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 value="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 value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="ListItemFlag"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/list-item-flag"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value"/> </mapping> </definition> </element> <element> <path value="List.entry.deleted"/> <definition> <short value="If this item is actually marked as deleted"/> <formal value="True if this item is marked as deleted in the list."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="added: .updateMode=("A","AR") retained: .updateMode="NC" updated: .updateMode="R" deleted: .updateMode="D""/> </mapping> </definition> </element> <element> <path value="List.entry.date"/> <definition> <short value="When item added to list"/> <formal value="When this item was added to the list."/> <comments value="This is only useful and meaningful when the mode is "working"."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".availabilityTime"/> </mapping> </definition> </element> <element> <path value="List.entry.item"/> <definition> <short value="Actual entry"/> <formal value="A reference to the actual resource from which data was derived."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Any"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".target or .role or .role.entity"/> </mapping> </definition> </element> <element> <path value="List.emptyReason"/> <definition> <short value="Why list is empty"/> <formal value="If the list is empty, why the list is empty."/> <comments value="The various reasons for an empty list make a significant interpretation to its interpretation."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="ListEmptyReason"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/list-empty-reason"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=SUBJ,code<{ListEmptyReason}].value[type=CD]"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="code"/> <type value="token"/> <documentation value="What the purpose of this list is"/> <xpath value="f:List/f:code"/> </searchParam> <searchParam> <name value="date"/> <type value="date"/> <documentation value="When the list was prepared"/> <xpath value="f:List/f:date"/> </searchParam> <searchParam> <name value="empty-reason"/> <type value="token"/> <documentation value="Why list is empty"/> <xpath value="f:List/f:emptyReason"/> </searchParam> <searchParam> <name value="item"/> <type value="reference"/> <documentation value="Actual entry"/> <xpath value="f:List/f:entry/f:item"/> </searchParam> <searchParam> <name value="source"/> <type value="reference"/> <documentation value="Who and/or what defined the list contents"/> <xpath value="f:List/f:source"/> </searchParam> <searchParam> <name value="subject"/> <type value="reference"/> <documentation value="If all resources have the same subject"/> <xpath value="f:List/f:subject"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="list-definitions.html#List" title="A set of information summarized from a list of other resources."><b>List</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="list-definitions.html#List.identifier" title="Identifier for the List assigned for business purposes outside the context of FHIR."><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> <<a class="dict" href="list-definitions.html#List.code" title="This code defines the purpose of the list - why it was created."><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 href="valueset-list-example-codes.html" style="color: navy">What the purpose of this list is</a></span><span style="color: Gray"> --></span></code> <<a class="dict" href="list-definitions.html#List.subject" title="The common subject (or patient) of the resources that are in the list, if there is one."><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"> If all resources have the same subject</span><span style="color: Gray"> --></span></subject> <<a class="dict" href="list-definitions.html#List.source" title="The entity responsible for deciding what the contents of the list were."><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"> Who and/or what defined the list contents</span><span style="color: Gray"> --></span></source> <<a class="dict" href="list-definitions.html#List.date" title="The date that the list was prepared."><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> <<a class="dict" href="list-definitions.html#List.ordered" title="Whether items in the list have a meaningful order (this element modifies the meaning of other elements)"><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> <<a class="dict" href="list-definitions.html#List.mode" 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)"><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 href="list-mode.html" style="color: navy">working | snapshot | changes</a></span><span style="color: Gray"> --></span> <<a class="dict" href="list-definitions.html#List.entry" title="Entries in this list."><b>entry</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-1: A list can only have an emptyReason if it is empty"><b><img alt="??" src="lock.png"/> 0..*</b></span> Entries in the list --></span> <<a class="dict" href="list-definitions.html#List.entry.flag" 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."><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 href="valueset-list-item-flag.html" style="color: navy">Workflow information about this item</a></span><span style="color: Gray"> --></span></flag> <<a class="dict" href="list-definitions.html#List.entry.deleted" title="True if this item is marked as deleted in the list (this element modifies the meaning of other elements)"><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 style="color: brown" title="Inv-2: The deleted flag can only be used if the mode of the list is "changes""><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> <<a class="dict" href="list-definitions.html#List.entry.date" title="When this item was added to the list."><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> <<a class="dict" href="list-definitions.html#List.entry.item" title="A reference to the actual resource from which data was derived."><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> </entry> <<a class="dict" href="list-definitions.html#List.emptyReason" title="If the list is empty, why the list is empty."><b>emptyReason</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: A list can only have an emptyReason if it is empty"><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 href="valueset-list-empty-reason.html" style="color: navy">Why list is empty</a></span><span style="color: Gray"> --></span></emptyReason> </List> </pre></div> </summary> </entry> <entry> <title>"location" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/location</id> <link href="http://hl7.org/implement/standards/fhir/location.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="location-definitions.html#Location" title="Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated."><b>Location</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="location-definitions.html#Location.identifier" title="Unique code or number identifying the location to its users."><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 code or number identifying the location to its users</span><span style="color: Gray"> --></span></identifier> <<a class="dict" href="location-definitions.html#Location.name" title="Name of the location as used by humans. Does not need to be unique."><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> <<a class="dict" href="location-definitions.html#Location.description" title="Description of the Location, which helps in finding or referencing the place."><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> <<a class="dict" href="location-definitions.html#Location.type" title="Indicates the type of function performed at the location."><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 href="v3/vs/ServiceDeliveryLocationRoleType/index.html" style="color: navy">Indicates the type of function performed at the location</a><span style="color: Gray"> --></span></type> <<a class="dict" href="location-definitions.html#Location.telecom" 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."><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> <<a class="dict" href="location-definitions.html#Location.address" title="Physical location."><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> <<a class="dict" href="location-definitions.html#Location.physicalType" title="Physical form of the location, e.g. building, room, vehicle, road."><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 href="valueset-location-physical-type.html" style="color: navy">Physical form of the location</a></span><span style="color: Gray"> --></span></physicalType> <<a class="dict" href="location-definitions.html#Location.position" title="The absolute geographic location of the Location, expressed in a KML compatible manner (see notes below for KML)."><b>position</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..1</b></span> The absolute geographic location --></span> <<a class="dict" href="location-definitions.html#Location.position.longitude" title="Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below)."><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> <<a class="dict" href="location-definitions.html#Location.position.latitude" title="Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below)."><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> <<a class="dict" href="location-definitions.html#Location.position.altitude" title="Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below)."><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> </position> <<a class="dict" href="location-definitions.html#Location.managingOrganization" title="The organization that is responsible for the provisioning and upkeep of the location."><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"> The organization that is responsible for the provisioning and upkeep of the location</span><span style="color: Gray"> --></span></managingOrganization> <<a class="dict" href="location-definitions.html#Location.status" title="active | suspended | inactive (this element modifies the meaning of other elements)"><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 href="location-status.html" style="color: navy">active | suspended | inactive</a></span><span style="color: Gray"> --></span> <<a class="dict" href="location-definitions.html#Location.partOf" title="Another Location which this Location is physically part of."><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"> Another Location which this Location is physically part of</span><span style="color: Gray"> --></span></partOf> <<a class="dict" href="location-definitions.html#Location.mode" title="Indicates whether a resource instance represents a specific location or a class of locations (this element modifies the meaning of other elements)"><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 href="location-mode.html" style="color: navy">instance | kind</a></span><span style="color: Gray"> --></span> </Location> </pre></div> </text> <name value="location"/> <publisher value="FHIR Project"/> <description value="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 value="draft"/> <date value="2014-09-30"/> <requirements value="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. Examples of Locations are: * Building, ward, corridor or room * Freezer, incubator * Vehicle or lift * Home, shed, or a garage * Road, parking place, a park"/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <structure> <type value="Location"/> <publish value="true"/> <element> <path value="Location"/> <definition> <short value="Details and position information for a physical place"/> <formal value="Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Role[classCode=SDLC]."/> </mapping> </definition> </element> <element> <path value="Location.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Location.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Location.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Location.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Location.identifier"/> <definition> <short value="Unique code or number identifying the location to its users"/> <formal value="Unique code or number identifying the location to its users."/> <min value="0"/> <max value="1"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="id"/> </mapping> </definition> </element> <element> <path value="Location.name"/> <definition> <short value="Name of the location as used by humans"/> <formal value="Name of the location as used by humans. Does not need to be unique."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="name"/> </mapping> </definition> </element> <element> <path value="Location.description"/> <definition> <short value="Description of the Location, which helps in finding or referencing the place"/> <formal value="Description of the Location, which helps in finding or referencing the place."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="playingEntity[classCode=PLC determinerCode=INSTANCE].desc"/> </mapping> </definition> </element> <element> <path value="Location.type"/> <definition> <short value="Indicates the type of function performed at the location"/> <formal value="Indicates the type of function performed at the location."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="LocationType"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/v3/vs/ServiceDeliveryLocationRoleType"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="code"/> </mapping> </definition> </element> <element> <path value="Location.telecom"/> <definition> <short value="Contact details of the location"/> <formal value="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 value="0"/> <max value="*"/> <type> <code value="Contact"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="telecom"/> </mapping> </definition> </element> <element> <path value="Location.address"/> <definition> <short value="Physical location"/> <formal value="Physical location."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="Address"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="addr"/> </mapping> </definition> </element> <element> <path value="Location.physicalType"/> <definition> <short value="Physical form of the location"/> <formal value="Physical form of the location, e.g. building, room, vehicle, road."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="PhysicalType"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/location-physical-type"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="playingEntity [classCode=PLC].code"/> </mapping> </definition> </element> <element> <path value="Location.position"/> <definition> <short value="The absolute geographic location"/> <formal value="The absolute geographic location of the Location, expressed in a KML compatible manner (see notes below for KML)."/> <min value="0"/> <max value="1"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="playingEntity [classCode=PLC determinerCode=INSTANCE].positionText"/> </mapping> </definition> </element> <element> <path value="Location.position.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Location.position.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Location.position.longitude"/> <definition> <short value="Longitude as expressed in KML"/> <formal value="Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below)."/> <min value="1"/> <max value="1"/> <type> <code value="decimal"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="?? RIM Opted not to map the sub-elements of GPS location) is now an OBS"/> </mapping> </definition> </element> <element> <path value="Location.position.latitude"/> <definition> <short value="Latitude as expressed in KML"/> <formal value="Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below)."/> <min value="1"/> <max value="1"/> <type> <code value="decimal"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="?? RIM Opted not to map the sub-elements of GPS location) is now an OBS"/> </mapping> </definition> </element> <element> <path value="Location.position.altitude"/> <definition> <short value="Altitude as expressed in KML"/> <formal value="Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below)."/> <min value="0"/> <max value="1"/> <type> <code value="decimal"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="?? RIM Opted not to map the sub-elements of GPS location) is now an OBS"/> </mapping> </definition> </element> <element> <path value="Location.managingOrganization"/> <definition> <short value="The organization that is responsible for the provisioning and upkeep of the location"/> <formal value="The organization that is responsible for the provisioning and upkeep of the location."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Organization"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="scopingEntity[classCode=ORG determinerKind=INSTANCE]"/> </mapping> </definition> </element> <element> <path value="Location.status"/> <definition> <short value="active | suspended | inactive"/> <formal value="active | suspended | inactive."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="LocationStatus"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/location-status"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="statusCode"/> </mapping> </definition> </element> <element> <path value="Location.partOf"/> <definition> <short value="Another Location which this Location is physically part of"/> <formal value="Another Location which this Location is physically part of."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Location"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="inboundLink[typeCode=PART].source[classCode=SDLC]"/> </mapping> </definition> </element> <element> <path value="Location.mode"/> <definition> <short value="instance | kind"/> <formal value="Indicates whether a resource instance represents a specific location or a class of locations."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="LocationMode"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/location-mode"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="playingEntity[classCode=PLC].determinerCode"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="address"/> <type value="string"/> <documentation value="A (part of the) address of the location"/> <xpath value="f:Location/f:address"/> </searchParam> <searchParam> <name value="identifier"/> <type value="token"/> <documentation value="Unique code or number identifying the location to its users"/> <xpath value="f:Location/f:identifier"/> </searchParam> <searchParam> <name value="name"/> <type value="string"/> <documentation value="A (portion of the) name of the location"/> <xpath value="f:Location/f:name"/> </searchParam> <searchParam> <name value="near"/> <type value="token"/> <documentation value="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)"/> </searchParam> <searchParam> <name value="near-distance"/> <type value="token"/> <documentation value="A distance quantity to limit the near search to locations within a specific distance"/> </searchParam> <searchParam> <name value="partof"/> <type value="reference"/> <documentation value="The location of which this location is a part"/> <xpath value="f:Location/f:partOf"/> </searchParam> <searchParam> <name value="status"/> <type value="token"/> <documentation value="Searches for locations with a specific kind of status"/> <xpath value="f:Location/f:status"/> </searchParam> <searchParam> <name value="type"/> <type value="token"/> <documentation value="A code for the type of location"/> <xpath value="f:Location/f:type"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="location-definitions.html#Location" title="Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated."><b>Location</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="location-definitions.html#Location.identifier" title="Unique code or number identifying the location to its users."><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 code or number identifying the location to its users</span><span style="color: Gray"> --></span></identifier> <<a class="dict" href="location-definitions.html#Location.name" title="Name of the location as used by humans. Does not need to be unique."><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> <<a class="dict" href="location-definitions.html#Location.description" title="Description of the Location, which helps in finding or referencing the place."><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> <<a class="dict" href="location-definitions.html#Location.type" title="Indicates the type of function performed at the location."><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 href="v3/vs/ServiceDeliveryLocationRoleType/index.html" style="color: navy">Indicates the type of function performed at the location</a><span style="color: Gray"> --></span></type> <<a class="dict" href="location-definitions.html#Location.telecom" 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."><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> <<a class="dict" href="location-definitions.html#Location.address" title="Physical location."><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> <<a class="dict" href="location-definitions.html#Location.physicalType" title="Physical form of the location, e.g. building, room, vehicle, road."><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 href="valueset-location-physical-type.html" style="color: navy">Physical form of the location</a></span><span style="color: Gray"> --></span></physicalType> <<a class="dict" href="location-definitions.html#Location.position" title="The absolute geographic location of the Location, expressed in a KML compatible manner (see notes below for KML)."><b>position</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..1</b></span> The absolute geographic location --></span> <<a class="dict" href="location-definitions.html#Location.position.longitude" title="Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below)."><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> <<a class="dict" href="location-definitions.html#Location.position.latitude" title="Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below)."><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> <<a class="dict" href="location-definitions.html#Location.position.altitude" title="Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below)."><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> </position> <<a class="dict" href="location-definitions.html#Location.managingOrganization" title="The organization that is responsible for the provisioning and upkeep of the location."><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"> The organization that is responsible for the provisioning and upkeep of the location</span><span style="color: Gray"> --></span></managingOrganization> <<a class="dict" href="location-definitions.html#Location.status" title="active | suspended | inactive (this element modifies the meaning of other elements)"><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 href="location-status.html" style="color: navy">active | suspended | inactive</a></span><span style="color: Gray"> --></span> <<a class="dict" href="location-definitions.html#Location.partOf" title="Another Location which this Location is physically part of."><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"> Another Location which this Location is physically part of</span><span style="color: Gray"> --></span></partOf> <<a class="dict" href="location-definitions.html#Location.mode" title="Indicates whether a resource instance represents a specific location or a class of locations (this element modifies the meaning of other elements)"><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 href="location-mode.html" style="color: navy">instance | kind</a></span><span style="color: Gray"> --></span> </Location> </pre></div> </summary> </entry> <entry> <title>"media" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/media</id> <link href="http://hl7.org/implement/standards/fhir/media.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="media-definitions.html#Media" title="A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference."><b>Media</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="media-definitions.html#Media.type" title="Whether the media is a photo (still image), an audio recording, or a video recording."><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 href="media-type.html" style="color: navy">photo | video | audio<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span> <<a class="dict" href="media-definitions.html#Media.subtype" 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."><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 href="valueset-media-subtype.html" style="color: navy">The type of acquisition equipment/process<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></subtype> <<a class="dict" href="media-definitions.html#Media.identifier" 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."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></identifier> <<a class="dict" href="media-definitions.html#Media.dateTime" 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."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="media-definitions.html#Media.subject" title="Who/What this Media is a record of."><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"> Who/What this Media is a record of<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></subject> <<a class="dict" href="media-definitions.html#Media.operator" title="The person who administered the collection of the image."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></operator> <<a class="dict" href="media-definitions.html#Media.view" title="The name of the imaging view e.g Lateral or Antero-posterior (AP)."><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 href="valueset-media-view.html" style="color: navy">Imaging view e.g Lateral or Antero-posterior<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></view> <<a class="dict" href="media-definitions.html#Media.deviceName" title="The name of the device / manufacturer of the device that was used to make the recording."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="media-definitions.html#Media.height" title="Height of the image in pixels(photo/video)."><b>height</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#integer">integer</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: Height can only be used for a photo or video"><b><img alt="??" src="lock.png"/> 0..1</b></span> <span style="color: navy">Height of the image in pixels(photo/video)<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="media-definitions.html#Media.width" title="Width of the image in pixels (photo/video)."><b>width</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#integer">integer</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-2: Width can only be used for a photo or video"><b><img alt="??" src="lock.png"/> 0..1</b></span> <span style="color: navy">Width of the image in pixels (photo/video)<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="media-definitions.html#Media.frames" 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."><b>frames</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#integer">integer</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-3: Frames can only be used for a photo"><b><img alt="??" src="lock.png"/> 0..1</b></span> <span style="color: navy">Number of frames if > 1 (photo)<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="media-definitions.html#Media.length" title="The length of the recording in seconds - for audio and video."><b>length</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#integer">integer</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-4: Length can only be used for an audio or a video"><b><img alt="??" src="lock.png"/> 0..1</b></span> <span style="color: navy">Length in seconds (audio / video)<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="media-definitions.html#Media.content" title="The actual content of the media - inline or by direct reference to the media source file."><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> </Media> </pre></div> </text> <name value="media"/> <publisher value="FHIR Project"/> <description value="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 value="draft"/> <date value="2014-09-30"/> <requirements value="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: * Photos of patients and staff for identification purposes * Photos and videos of diagnostic or care provision procedures for recording purposes * Storing scans and faxes of paper documents where not enough metadata exists to create a DocumentReference * Images on diagnostic reports The 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 value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="dicom"/> <uri value="http://nema.org/dicom"/> <name value="DICOM"/> </mapping> <structure> <type value="Media"/> <publish value="true"/> <element> <path value="Media"/> <definition> <short value="A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference"/> <formal value="A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <constraint> <key value="3"/> <name value="Frames rule"/> <severity value="error"/> <human value="Frames can only be used for a photo"/> <xpath value="(f:type/@value='photo') or not(f:frames)"/> </constraint> <constraint> <key value="2"/> <name value="Width rule"/> <severity value="error"/> <human value="Width can only be used for a photo or video"/> <xpath value="not(f:type/@value='audio') or not(f:width)"/> </constraint> <constraint> <key value="1"/> <name value="Height rule"/> <severity value="error"/> <human value="Height can only be used for a photo or video"/> <xpath value="not(f:type/@value='audio') or not(f:height)"/> </constraint> <constraint> <key value="4"/> <name value="Length rule"/> <severity value="error"/> <human value="Length can only be used for an audio or a video"/> <xpath value="not(f:type/@value='photo') or not(f:length)"/> </constraint> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Act[classCode="DGIMG", moodCode="EVN"]"/> </mapping> </definition> </element> <element> <path value="Media.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Media.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Media.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Media.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Media.type"/> <definition> <short value="photo | video | audio"/> <formal value="Whether the media is a photo (still image), an audio recording, or a video recording."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="MediaType"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/media-type"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> </definition> </element> <element> <path value="Media.subtype"/> <definition> <short value="The type of acquisition equipment/process"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="MediaSubtype"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/media-subtype"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN&quo t;].code"/> </mapping> <mapping> <identity value="dicom"/> <map value="0008,0060 | 0008,1032"/> </mapping> </definition> </element> <element> <path value="Media.identifier"/> <definition> <short value="Identifier(s) for the image"/> <formal value="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 value="The identifier label and use can be used to determine what kind of identifier it is."/> <min value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> <mapping> <identity value="dicom"/> <map value="0008,0018 | ~0008,0050 | 0020,000D | 0020,000E"/> </mapping> </definition> </element> <element> <path value="Media.dateTime"/> <definition> <short value="When the media was taken/recorded (end)"/> <formal value="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 value="For an image including multiple frames, this is the start time."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".effectiveTime"/> </mapping> <mapping> <identity value="dicom"/> <map value="0008,0020 + 0008,0030"/> </mapping> </definition> </element> <element> <path value="Media.subject"/> <definition> <short value="Who/What this Media is a record of"/> <formal value="Who/What this Media is a record of."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Group"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Device"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Specimen"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode="SUBJ"]…"/> </mapping> <mapping> <identity value="dicom"/> <map value="~0010,0020"/> </mapping> </definition> </element> <element> <path value="Media.operator"/> <definition> <short value="The person who generated the image"/> <formal value="The person who administered the collection of the image."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode="PERF"]…"/> </mapping> <mapping> <identity value="dicom"/> <map value="0008,1060?"/> </mapping> </definition> </element> <element> <path value="Media.view"/> <definition> <short value="Imaging view e.g Lateral or Antero-posterior"/> <formal value="The name of the imaging view e.g Lateral or Antero-posterior (AP)."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="MediaView"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/media-view"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="DiagnosticImage.subjectOrientationCode"/> </mapping> </definition> </element> <element> <path value="Media.deviceName"/> <definition> <short value="Name of the device/manufacturer"/> <formal value="The name of the device / manufacturer of the device that was used to make the recording."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode="DEV"].role.player.Entity[classCode="DEV"].name"/> </mapping> <mapping> <identity value="dicom"/> <map value="0008,0070"/> </mapping> </definition> </element> <element> <path value="Media.height"/> <definition> <short value="Height of the image in pixels(photo/video)"/> <formal value="Height of the image in pixels(photo/video)."/> <min value="0"/> <max value="1"/> <type> <code value="integer"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode="COMP].target[classCode="OBS", moodCode="EVN" ;,code="<CODE>"].value"/> </mapping> <mapping> <identity value="dicom"/> <map value="0028,0010"/> </mapping> </definition> </element> <element> <path value="Media.width"/> <definition> <short value="Width of the image in pixels (photo/video)"/> <formal value="Width of the image in pixels (photo/video)."/> <min value="0"/> <max value="1"/> <type> <code value="integer"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode="COMP].target[classCode="OBS", moodCode="EVN" ;,code="<CODE>"].value"/> </mapping> <mapping> <identity value="dicom"/> <map value="0028,0011"/> </mapping> </definition> </element> <element> <path value="Media.frames"/> <definition> <short value="Number of frames if > 1 (photo)"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="integer"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode="COMP].target[classCode="OBS", moodCode="EVN" ;,code="<CODE>"].value"/> </mapping> </definition> </element> <element> <path value="Media.length"/> <definition> <short value="Length in seconds (audio / video)"/> <formal value="The length of the recording in seconds - for audio and video."/> <min value="0"/> <max value="1"/> <type> <code value="integer"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode="COMP].target[classCode="OBS", moodCode="EVN" ;,code="<CODE>"].value"/> </mapping> <mapping> <identity value="dicom"/> <map value="~0028,0002"/> </mapping> </definition> </element> <element> <path value="Media.content"/> <definition> <short value="Actual Media - reference or data"/> <formal value="The actual content of the media - inline or by direct reference to the media source file."/> <comments value="Recommended content types: image/jpeg, image/png, image/tiff, video/mpeg, audio/mp4, application/dic om. Application/dicom can contain the transfer syntax as a parameter."/> <min value="1"/> <max value="1"/> <type> <code value="Attachment"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".text"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="date"/> <type value="date"/> <documentation value="When the media was taken/recorded (end)"/> <xpath value="f:Media/f:dateTime"/> </searchParam> <searchParam> <name value="identifier"/> <type value="token"/> <documentation value="Identifier(s) for the image"/> <xpath value="f:Media/f:identifier"/> </searchParam> <searchParam> <name value="operator"/> <type value="reference"/> <documentation value="The person who generated the image"/> <xpath value="f:Media/f:operator"/> </searchParam> <searchParam> <name value="subject"/> <type value="reference"/> <documentation value="Who/What this Media is a record of"/> <xpath value="f:Media/f:subject"/> </searchParam> <searchParam> <name value="subtype"/> <type value="token"/> <documentation value="The type of acquisition equipment/process"/> <xpath value="f:Media/f:subtype"/> </searchParam> <searchParam> <name value="type"/> <type value="token"/> <documentation value="photo | video | audio"/> <xpath value="f:Media/f:type"/> </searchParam> <searchParam> <name value="view"/> <type value="token"/> <documentation value="Imaging view e.g Lateral or Antero-posterior"/> <xpath value="f:Media/f:view"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="media-definitions.html#Media" title="A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference."><b>Media</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="media-definitions.html#Media.type" title="Whether the media is a photo (still image), an audio recording, or a video recording."><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 href="media-type.html" style="color: navy">photo | video | audio<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span> <<a class="dict" href="media-definitions.html#Media.subtype" 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."><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 href="valueset-media-subtype.html" style="color: navy">The type of acquisition equipment/process<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></subtype> <<a class="dict" href="media-definitions.html#Media.identifier" 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."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></identifier> <<a class="dict" href="media-definitions.html#Media.dateTime" 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."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="media-definitions.html#Media.subject" title="Who/What this Media is a record of."><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"> Who/What this Media is a record of<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></subject> <<a class="dict" href="media-definitions.html#Media.operator" title="The person who administered the collection of the image."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></operator> <<a class="dict" href="media-definitions.html#Media.view" title="The name of the imaging view e.g Lateral or Antero-posterior (AP)."><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 href="valueset-media-view.html" style="color: navy">Imaging view e.g Lateral or Antero-posterior<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></view> <<a class="dict" href="media-definitions.html#Media.deviceName" title="The name of the device / manufacturer of the device that was used to make the recording."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="media-definitions.html#Media.height" title="Height of the image in pixels(photo/video)."><b>height</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#integer">integer</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: Height can only be used for a photo or video"><b><img alt="??" src="lock.png"/> 0..1</b></span> <span style="color: navy">Height of the image in pixels(photo/video)<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="media-definitions.html#Media.width" title="Width of the image in pixels (photo/video)."><b>width</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#integer">integer</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-2: Width can only be used for a photo or video"><b><img alt="??" src="lock.png"/> 0..1</b></span> <span style="color: navy">Width of the image in pixels (photo/video)<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="media-definitions.html#Media.frames" 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."><b>frames</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#integer">integer</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-3: Frames can only be used for a photo"><b><img alt="??" src="lock.png"/> 0..1</b></span> <span style="color: navy">Number of frames if > 1 (photo)<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="media-definitions.html#Media.length" title="The length of the recording in seconds - for audio and video."><b>length</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#integer">integer</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-4: Length can only be used for an audio or a video"><b><img alt="??" src="lock.png"/> 0..1</b></span> <span style="color: navy">Length in seconds (audio / video)<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="media-definitions.html#Media.content" title="The actual content of the media - inline or by direct reference to the media source file."><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> </Media> </pre></div> </summary> </entry> <entry> <title>"medication" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/medication</id> <link href="http://hl7.org/implement/standards/fhir/medication.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="medication-definitions.html#Medication" title="Primarily used for identification and definition of Medication, but also covers ingredients and packaging."><b>Medication</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="medication-definitions.html#Medication.name" 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."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="medication-definitions.html#Medication.code" 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."><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 href="valueset-medication-codes.html" style="color: navy">Codes that identify this medication<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></code> <<a class="dict" href="medication-definitions.html#Medication.isBrand" title="Set to true if the item is attributable to a specific manufacturer (even if we don't know who that is)."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="medication-definitions.html#Medication.manufacturer" title="Describes the details of the 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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></manufacturer> <<a class="dict" href="medication-definitions.html#Medication.kind" title="Medications are either a single administrable product or a package that contains one or more products."><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 href="medication-kind.html" style="color: navy">product | package<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span> <<a class="dict" href="medication-definitions.html#Medication.product" title="Information that only applies to products (not packages)."><b>product</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..1</b></span> Administrable medication details --></span> <<a class="dict" href="medication-definitions.html#Medication.product.form" title="Describes the form of the item. Powder; tables; carton."><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 href="valueset-medication-form-codes.html" style="color: navy">powder | tablets | carton +</a></span><span style="color: Gray"> --></span></form> <<a class="dict" href="medication-definitions.html#Medication.product.ingredient" title="Identifies a particular constituent of interest in the product."><b>ingredient</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Active or inactive ingredient --></span> <<a class="dict" href="medication-definitions.html#Medication.product.ingredient.item" title="The actual ingredient - either a substance (simple ingredient) or another medication."><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> <<a class="dict" href="medication-definitions.html#Medication.product.ingredient.amount" title="Specifies how many (or how much) of the items there are in this Medication. E.g. 250 mg per tablet."><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> </ingredient> </product> <<a class="dict" href="medication-definitions.html#Medication.package" title="Information that only applies to packages (not products)."><b>package</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..1</b></span> Details about packaged medications --></span> <<a class="dict" href="medication-definitions.html#Medication.package.container" title="The kind of container that this package comes as."><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 href="valueset-medication-package-form-codes.html" style="color: navy">E.g. box, vial, blister-pack</a></span><span style="color: Gray"> --></span></container> <<a class="dict" href="medication-definitions.html#Medication.package.content" title="A set of components that go to make up the described item."><b>content</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> What is in the package? --></span> <<a class="dict" href="medication-definitions.html#Medication.package.content.item" title="Identifies one of the items in the package."><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> <<a class="dict" href="medication-definitions.html#Medication.package.content.amount" title="The amount of the product that is in the package."><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> </content> </package> </Medication> </pre></div> </text> <name value="medication"/> <publisher value="FHIR Project"/> <description value="Basic Profile. Primarily used for identification and definition of Medication, but also covers ingredients and packaging."/> <status value="draft"/> <date value="2014-09-30"/> <requirements value="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. The 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. Depending 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 value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <structure> <type value="Medication"/> <publish value="true"/> <element> <path value="Medication"/> <definition> <short value="Definition of a Medication"/> <formal value="Primarily used for identification and definition of Medication, but also covers ingredients and packaging."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="ManufacturedProduct[classCode=ADMM]"/> </mapping> </definition> </element> <element> <path value="Medication.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Medication.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Medication.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Medication.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Medication.name"/> <definition> <short value="Common / Commercial name"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".name"/> </mapping> <mapping> <identity value="v2"/> <map value="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"/> </mapping> </definition> </element> <element> <path value="Medication.code"/> <definition> <short value="Codes that identify this medication"/> <formal value="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 value="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 value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="MedicationFormalRepresentation"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/medication-codes"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> <mapping> <identity value="v2"/> <map value="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"/> </mapping> </definition> </element> <element> <path value="Medication.isBrand"/> <definition> <short value="True if a brand"/> <formal value="Set to true if the item is attributable to a specific manufacturer (even if we don't know who that is)."/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="true if .player.scopingRole[typeCode=MANU] exists"/> </mapping> </definition> </element> <element> <path value="Medication.manufacturer"/> <definition> <short value="Manufacturer of the item"/> <formal value="Describes the details of the manufacturer."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Organization"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".player.scopingRole[typeCode=MANU].scoper"/> </mapping> <mapping> <identity value="v2"/> <map value="RXD-20-Substance Manufacturer Name / RXG-21-Substance Manufacturer Name / RXA-17-Substance Manufacturer Name"/> </mapping> </definition> </element> <element> <path value="Medication.kind"/> <definition> <short value="product | package"/> <formal value="Medications are either a single administrable product or a package that contains one or more products."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="MedicationKind"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/medication-kind"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".player.classCode (CONT or not)"/> </mapping> </definition> </element> <element> <path value="Medication.product"/> <definition> <short value="Administrable medication details"/> <formal value="Information that only applies to products (not packages)."/> <min value="0"/> <max value="1"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".player [classCode != CONT]"/> </mapping> </definition> </element> <element> <path value="Medication.product.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Medication.product.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Medication.product.form"/> <definition> <short value="powder | tablets | carton +"/> <formal value="Describes the form of the item. Powder; tables; carton."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="MedicationForm"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/medication-form-codes"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".formCode"/> </mapping> <mapping> <identity value="v2"/> <map value="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"/> </mapping> </definition> </element> <element> <path value="Medication.product.ingredient"/> <definition> <short value="Active or inactive ingredient"/> <formal value="Identifies a particular constituent of interest in the product."/> <comments value="The ingredients need not be a complete list; usually only active ingredients are listed."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".scopesRole[typeCode=INGR]"/> </mapping> </definition> </element> <element> <path value="Medication.product.ingredient.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Medication.product.ingredient.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Medication.product.ingredient.item"/> <definition> <short value="The product contained"/> <formal value="The actual ingredient - either a substance (simple ingredient) or another medication."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Substance"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Medication"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".player"/> </mapping> <mapping> <identity value="v2"/> <map value="if substance: RXC-2-Component Code if medication: RXO-1-Requested Give Code / RXE-2-Give Code / RXD-2-Dispense/Give Code / RXG-4-Give Code / RXA-5-Administered Code"/> </mapping> </definition> </element> <element> <path value="Medication.product.ingredient.amount"/> <definition> <short value="How much ingredient in product"/> <formal value="Specifies how many (or how much) of the items there are in this Medication. E.g. 250 mg per tablet."/> <min value="0"/> <max value="1"/> <type> <code value="Ratio"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".quantity"/> </mapping> <mapping> <identity value="v2"/> <map value="if substance: RXC-3-Component Amount & RXC-4-Component Units if 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"/> </mapping> </definition> </element> <element> <path value="Medication.package"/> <definition> <short value="Details about packaged medications"/> <formal value="Information that only applies to packages (not products)."/> <min value="0"/> <max value="1"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".player[classCode=CONT]"/> </mapping> </definition> </element> <element> <path value="Medication.package.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Medication.package.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Medication.package.container"/> <definition> <short value="E.g. box, vial, blister-pack"/> <formal value="The kind of container that this package comes as."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="MedicationContainer"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/medication-package-form-codes"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> </definition> </element> <element> <path value="Medication.package.content"/> <definition> <short value="What is in the package?"/> <formal value="A set of components that go to make up the described item."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".scopesRole[typeCode=CONT]"/> </mapping> </definition> </element> <element> <path value="Medication.package.content.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Medication.package.content.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Medication.package.content.item"/> <definition> <short value="A product in the package"/> <formal value="Identifies one of the items in the package."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Medication"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".player"/> </mapping> </definition> </element> <element> <path value="Medication.package.content.amount"/> <definition> <short value="How many are in the package?"/> <formal value="The amount of the product that is in the package."/> <min value="0"/> <max value="1"/> <type> <code value="Quantity"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".quantity"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="code"/> <type value="token"/> <documentation value="Codes that identify this medication"/> <xpath value="f:Medication/f:code"/> </searchParam> <searchParam> <name value="container"/> <type value="token"/> <documentation value="E.g. box, vial, blister-pack"/> <xpath value="f:Medication/f:package/f:container"/> </searchParam> <searchParam> <name value="content"/> <type value="reference"/> <documentation value="A product in the package"/> <xpath value="f:Medication/f:package/f:content/f:item"/> </searchParam> <searchParam> <name value="form"/> <type value="token"/> <documentation value="powder | tablets | carton +"/> <xpath value="f:Medication/f:product/f:form"/> </searchParam> <searchParam> <name value="ingredient"/> <type value="reference"/> <documentation value="The product contained"/> <xpath value="f:Medication/f:product/f:ingredient/f:item"/> </searchParam> <searchParam> <name value="manufacturer"/> <type value="reference"/> <documentation value="Manufacturer of the item"/> <xpath value="f:Medication/f:manufacturer"/> </searchParam> <searchParam> <name value="name"/> <type value="string"/> <documentation value="Common / Commercial name"/> <xpath value="f:Medication/f:name"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="medication-definitions.html#Medication" title="Primarily used for identification and definition of Medication, but also covers ingredients and packaging."><b>Medication</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="medication-definitions.html#Medication.name" 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."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="medication-definitions.html#Medication.code" 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."><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 href="valueset-medication-codes.html" style="color: navy">Codes that identify this medication<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></code> <<a class="dict" href="medication-definitions.html#Medication.isBrand" title="Set to true if the item is attributable to a specific manufacturer (even if we don't know who that is)."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="medication-definitions.html#Medication.manufacturer" title="Describes the details of the 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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></manufacturer> <<a class="dict" href="medication-definitions.html#Medication.kind" title="Medications are either a single administrable product or a package that contains one or more products."><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 href="medication-kind.html" style="color: navy">product | package<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span> <<a class="dict" href="medication-definitions.html#Medication.product" title="Information that only applies to products (not packages)."><b>product</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..1</b></span> Administrable medication details --></span> <<a class="dict" href="medication-definitions.html#Medication.product.form" title="Describes the form of the item. Powder; tables; carton."><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 href="valueset-medication-form-codes.html" style="color: navy">powder | tablets | carton +</a></span><span style="color: Gray"> --></span></form> <<a class="dict" href="medication-definitions.html#Medication.product.ingredient" title="Identifies a particular constituent of interest in the product."><b>ingredient</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Active or inactive ingredient --></span> <<a class="dict" href="medication-definitions.html#Medication.product.ingredient.item" title="The actual ingredient - either a substance (simple ingredient) or another medication."><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> <<a class="dict" href="medication-definitions.html#Medication.product.ingredient.amount" title="Specifies how many (or how much) of the items there are in this Medication. E.g. 250 mg per tablet."><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> </ingredient> </product> <<a class="dict" href="medication-definitions.html#Medication.package" title="Information that only applies to packages (not products)."><b>package</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..1</b></span> Details about packaged medications --></span> <<a class="dict" href="medication-definitions.html#Medication.package.container" title="The kind of container that this package comes as."><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 href="valueset-medication-package-form-codes.html" style="color: navy">E.g. box, vial, blister-pack</a></span><span style="color: Gray"> --></span></container> <<a class="dict" href="medication-definitions.html#Medication.package.content" title="A set of components that go to make up the described item."><b>content</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> What is in the package? --></span> <<a class="dict" href="medication-definitions.html#Medication.package.content.item" title="Identifies one of the items in the package."><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> <<a class="dict" href="medication-definitions.html#Medication.package.content.amount" title="The amount of the product that is in the package."><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> </content> </package> </Medication> </pre></div> </summary> </entry> <entry> <title>"medicationadministration" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/medicationadministration</id> <link href="http://hl7.org/implement/standards/fhir/medicationadministration.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration" 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. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner."><b>MedicationAdministration</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.identifier" 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)"><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> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.status" 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)"><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 href="medication-admin-status.html" style="color: navy">in progress | on hold | completed | entered in error | stopped</a></span><span style="color: Gray"> --></span> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.patient" title="The person or animal to whom the medication was given."><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> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.practitioner" title="The individual who was responsible for giving the medication to the patient."><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> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.encounter" title="The visit or admission the or other contact between patient and health care provider the medication administration was performed as part of."><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> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.prescription" title="The original request, instruction or authority to perform the administration."><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"> Order administration performed against</span><span style="color: Gray"> --></span></prescription> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.wasNotGiven" title="Set this to true if the record is saying that the medication was NOT administered (this element modifies the meaning of other elements)"><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> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.reasonNotGiven" title="A code indicating why the administration was not performed."><b>reasonNotGiven</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-2: Reason not given is only permitted if wasNotGiven is true"><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 href="valueset-reason-medication-not-given-codes.html" style="color: navy">Reason administration not performed</a></span><span style="color: Gray"> --></span></reasonNotGiven> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.whenGiven" 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."><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> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.medication" 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."><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> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.device" title="The device used in administering the medication to the patient. E.g. a particular infusion pump."><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> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.dosage" title="Provides details of how much of the medication was administered."><b>dosage</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Medicine administration instructions to the patient/carer --></span> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.dosage.timing_x_" 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)."><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]> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.dosage.asNeeded_x_" 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."><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]> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.dosage.site" title="A coded specification of the anatomic site where the medication first entered the body. E.g. "left arm"."><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 href="valueset-approach-site-codes.html" style="color: navy">Body site administered to</a></span><span style="color: Gray"> --></span></site> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.dosage.route" 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."><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 href="valueset-route-codes.html" style="color: navy">Path of substance into body</a></span><span style="color: Gray"> --></span></route> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.dosage.method" 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. Terminologies used often pre-coordinate this term with the route and or form of administration."><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 href="valueset-administration-method-codes.html" style="color: navy">How drug was administered</a></span><span style="color: Gray"> --></span></method> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.dosage.quantity" 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."><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> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.dosage.rate" 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."><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> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.dosage.maxDosePerPeriod" 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."><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> </dosage> </MedicationAdministration> </pre></div> </text> <name value="medicationadministration"/> <publisher value="FHIR Project"/> <description value="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. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner."/> <status value="draft"/> <date value="2014-09-30"/> <requirements value="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 value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <structure> <type value="MedicationAdministration"/> <publish value="true"/> <element> <path value="MedicationAdministration"/> <definition> <short value="Administration of medication to a patient"/> <formal value="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. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <constraint> <key value="2"/> <name value="Not given reason"/> <severity value="error"/> <human value="Reason not given is only permitted if wasNotGiven is true"/> <xpath value="not(exists(f:reasonNotGiven)) or f:wasNotGiven='true'"/> </constraint> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="SubstanceAdministration"/> </mapping> </definition> </element> <element> <path value="MedicationAdministration.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MedicationAdministration.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MedicationAdministration.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MedicationAdministration.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MedicationAdministration.identifier"/> <definition> <short value="External identifier"/> <formal value="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 value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="id"/> </mapping> <mapping> <identity value="v2"/> <map value="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..*)"/> </mapping> </definition> </element> <element> <path value="MedicationAdministration.status"/> <definition> <short value="in progress | on hold | completed | entered in error | stopped"/> <formal value="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 value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="MedicationAdministrationStatus"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/medication-admin-status"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="statusCode"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-20-Completion Status"/> </mapping> </definition> </element> <element> <path value="MedicationAdministration.patient"/> <definition> <short value="Who received medication?"/> <formal value="The person or animal to whom the medication was given."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="subject->Patient"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-3-Patient ID List"/> </mapping> </definition> </element> <element> <path value="MedicationAdministration.practitioner"/> <definition> <short value="Who administered substance?"/> <formal value="The individual who was responsible for giving the medication to the patient."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="performer->Role"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-10-Administering Provider / PRT-5-Participation Person: PRT-4-Participation='AP' (RXA-10 is deprecated)"/> </mapping> </definition> </element> <element> <path value="MedicationAdministration.encounter"/> <definition> <short value="Encounter administered as part of"/> <formal value="The visit or admission the or other contact between patient and health care provider the medication administration was performed as part of."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Encounter"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="component->EncounterEvent"/> </mapping> <mapping> <identity value="v2"/> <map value="PV1-19-Visit Number"/> </mapping> </definition> </element> <element> <path value="MedicationAdministration.prescription"/> <definition> <short value="Order administration performed against"/> <formal value="The original request, instruction or authority to perform the administration."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/MedicationPrescription"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="InFullfillmentOf->SubstanceAdministration"/> </mapping> <mapping> <identity value="v2"/> <map value="ORC-3-Filler Order Number / ORC-2-Placer Order Number"/> </mapping> </definition> </element> <element> <path value="MedicationAdministration.wasNotGiven"/> <definition> <short value="True if medication not administered"/> <formal value="Set this to true if the record is saying that the medication was NOT administered."/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="actionNegationInd"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-20-Completion Status='NA'"/> </mapping> </definition> </element> <element> <path value="MedicationAdministration.reasonNotGiven"/> <definition> <short value="Reason administration not performed"/> <formal value="A code indicating why the administration was not performed."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="MedicationAdministrationNegationReason"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/reason-medication-not-given-codes"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="Reason->Observation->Value"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-9-Administration Notes:RXA-20-Completion Status='NA'"/> </mapping> </definition> </element> <element> <path value="MedicationAdministration.whenGiven"/> <definition> <short value="Start and end time of administration"/> <formal value="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 value="1"/> <max value="1"/> <type> <code value="Period"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="effectiveTime"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-3-Date/Time Start of Administration / RXA-4-Date/Time End of Administration"/> </mapping> </definition> </element> <element> <path value="MedicationAdministration.medication"/> <definition> <short value="What was administered?"/> <formal value="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 value="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 value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Medication"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Consumeable->AdministerableMedication"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-5-Administered Code"/> </mapping> </definition> </element> <element> <path value="MedicationAdministration.device"/> <definition> <short value="Device used to administer"/> <formal value="The device used in administering the medication to the patient. E.g. a particular infusion pump."/> <min value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Device"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="device->Access OR device->AssignedDevice"/> </mapping> <mapping> <identity value="v2"/> <map value="PRT-10-Participation Device"/> </mapping> </definition> </element> <element> <path value="MedicationAdministration.dosage"/> <definition> <short value="Medicine administration instructions to the patient/carer"/> <formal value="Provides details of how much of the medication was administered."/> <min value="0"/> <max value="*"/> <constraint> <key value="1"/> <name value="Dose"/> <severity value="error"/> <human value="SHALL have at least one of dosage.quantity and dosage.rate"/> <xpath value="exists(f:quantity) or exists(f:rate)"/> </constraint> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="component->SubstanceAdministrationEvent"/> </mapping> </definition> </element> <element> <path value="MedicationAdministration.dosage.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MedicationAdministration.dosage.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MedicationAdministration.dosage.timing[x]"/> <definition> <short value="When dose(s) were given"/> <formal value="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 value="This is generally only relevant if the administration record represents a summary of multiple administrations."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <type> <code value="Period"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="effectiveTime[TS or IVL_TS)"/> </mapping> <mapping> <identity value="v2"/> <map value="RAS:TQ1"/> </mapping> </definition> </element> <element> <path value="MedicationAdministration.dosage.asNeeded[x]"/> <definition> <short value="Take "as needed" f(or x)"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="MedicationAsNeededReason"/> <isExtensible value="true"/> <conformance value="preferred"/> <description value="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."/> </binding> <mapping> <identity value="rim"/> <map value="boolean: precondition.negationInd (inversed - so negationInd = true means asNeeded=false CodeableConcept: precondition.observationEventCriterion[code="Assertion"].value"/> </mapping> </definition> </element> <element> <path value="MedicationAdministration.dosage.site"/> <definition> <short value="Body site administered to"/> <formal value="A coded specification of the anatomic site where the medication first entered the body. E.g. "left arm"."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="MedicationAdministrationSite"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/approach-site-codes"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="approachSiteCode"/> </mapping> <mapping> <identity value="v2"/> <map value="RXR-2-Administration Site"/> </mapping> </definition> </element> <element> <path value="MedicationAdministration.dosage.route"/> <definition> <short value="Path of substance into body"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="RouteOfAdministration"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/route-codes"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="routeCode"/> </mapping> <mapping> <identity value="v2"/> <map value="RXR-1-Route"/> </mapping> </definition> </element> <element> <path value="MedicationAdministration.dosage.method"/> <definition> <short value="How drug was administered"/> <formal value="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. Terminologies used often pre-coordinate this term with the route and or form of administration."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="MedicationAdministrationMethod"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/administration-method-codes"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="methodCode"/> </mapping> <mapping> <identity value="v2"/> <map value="RXR-4-Administration Method"/> </mapping> </definition> </element> <element> <path value="MedicationAdministration.dosage.quantity"/> <definition> <short value="Amount administered in one dose"/> <formal value="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 value="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 value="0"/> <max value="1"/> <type> <code value="Quantity"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="doseQuantity"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-6-Administered Amount / RXA-7.1-Administered Units.code / RXA-7.3-Administered Units.name of coding system (uri<->code system mapping required)"/> </mapping> </definition> </element> <element> <path value="MedicationAdministration.dosage.rate"/> <definition> <short value="Dose quantity per unit of time"/> <formal value="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 value="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 value="0"/> <max value="1"/> <type> <code value="Ratio"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="rateQuantity"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-12-Administered Per (Time Unit)"/> </mapping> </definition> </element> <element> <path value="MedicationAdministration.dosage.maxDosePerPeriod"/> <definition> <short value="Total dose that was consumed per unit of time"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="Ratio"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="maxDoseQuantity"/> </mapping> <mapping> <identity value="v2"/> <map value="RXE-4-Give Amount - Maximum / RXE-5-Give Units"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="device"/> <type value="reference"/> <documentation value="Return administrations with this administration device identity"/> <xpath value="f:MedicationAdministration/f:device"/> </searchParam> <searchParam> <name value="encounter"/> <type value="reference"/> <documentation value="Return administrations that share this encounter"/> <xpath value="f:MedicationAdministration/f:encounter"/> </searchParam> <searchParam> <name value="identifier"/> <type value="token"/> <documentation value="Return administrations with this external identity"/> <xpath value="f:MedicationAdministration/f:identifier"/> </searchParam> <searchParam> <name value="medication"/> <type value="reference"/> <documentation value="Return administrations of this medication"/> <xpath value="f:MedicationAdministration/f:medication"/> </searchParam> <searchParam> <name value="notgiven"/> <type value="token"/> <documentation value="Administrations that were not made"/> <xpath value="f:MedicationAdministration/f:wasNotGiven"/> </searchParam> <searchParam> <name value="patient"/> <type value="reference"/> <documentation value="The identity of a patient to list administrations for"/> <xpath value="f:MedicationAdministration/f:patient"/> </searchParam> <searchParam> <name value="prescription"/> <type value="reference"/> <documentation value="The identity of a prescription to list administrations from"/> <xpath value="f:MedicationAdministration/f:prescription"/> </searchParam> <searchParam> <name value="status"/> <type value="token"/> <documentation value="MedicationAdministration event status (for example one of active/paused/completed/nullified)"/> <xpath value="f:MedicationAdministration/f:status"/> </searchParam> <searchParam> <name value="whengiven"/> <type value="date"/> <documentation value="Date of administration"/> <xpath value="f:MedicationAdministration/f:whenGiven"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration" 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. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner."><b>MedicationAdministration</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.identifier" 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)"><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> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.status" 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)"><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 href="medication-admin-status.html" style="color: navy">in progress | on hold | completed | entered in error | stopped</a></span><span style="color: Gray"> --></span> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.patient" title="The person or animal to whom the medication was given."><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> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.practitioner" title="The individual who was responsible for giving the medication to the patient."><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> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.encounter" title="The visit or admission the or other contact between patient and health care provider the medication administration was performed as part of."><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> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.prescription" title="The original request, instruction or authority to perform the administration."><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"> Order administration performed against</span><span style="color: Gray"> --></span></prescription> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.wasNotGiven" title="Set this to true if the record is saying that the medication was NOT administered (this element modifies the meaning of other elements)"><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> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.reasonNotGiven" title="A code indicating why the administration was not performed."><b>reasonNotGiven</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-2: Reason not given is only permitted if wasNotGiven is true"><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 href="valueset-reason-medication-not-given-codes.html" style="color: navy">Reason administration not performed</a></span><span style="color: Gray"> --></span></reasonNotGiven> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.whenGiven" 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."><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> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.medication" 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."><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> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.device" title="The device used in administering the medication to the patient. E.g. a particular infusion pump."><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> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.dosage" title="Provides details of how much of the medication was administered."><b>dosage</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Medicine administration instructions to the patient/carer --></span> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.dosage.timing_x_" 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)."><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]> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.dosage.asNeeded_x_" 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."><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]> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.dosage.site" title="A coded specification of the anatomic site where the medication first entered the body. E.g. "left arm"."><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 href="valueset-approach-site-codes.html" style="color: navy">Body site administered to</a></span><span style="color: Gray"> --></span></site> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.dosage.route" 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."><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 href="valueset-route-codes.html" style="color: navy">Path of substance into body</a></span><span style="color: Gray"> --></span></route> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.dosage.method" 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. Terminologies used often pre-coordinate this term with the route and or form of administration."><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 href="valueset-administration-method-codes.html" style="color: navy">How drug was administered</a></span><span style="color: Gray"> --></span></method> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.dosage.quantity" 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."><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> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.dosage.rate" 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."><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> <<a class="dict" href="medicationadministration-definitions.html#MedicationAdministration.dosage.maxDosePerPeriod" 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."><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> </dosage> </MedicationAdministration> </pre></div> </summary> </entry> <entry> <title>"medicationdispense" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/medicationdispense</id> <link href="http://hl7.org/implement/standards/fhir/medicationdispense.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense" title="Dispensing a medication to a named patient. This includes a description of the supply provided and the instructions for administering the medication."><b>MedicationDispense</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.identifier" title="Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR (this element modifies the meaning of other elements)"><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> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.status" title="A code specifying the state of the set of dispense events (this element modifies the meaning of other elements)"><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 href="medication-dispense-status.html" style="color: navy">in progress | on hold | completed | entered in error | stopped</a></span><span style="color: Gray"> --></span> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.patient" title="A link to a resource representing the person to whom the medication will be given."><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> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispenser" title="The individual responsible for dispensing the medication."><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"> Practitioner responsible for dispensing medication</span><span style="color: Gray"> --></span></dispenser> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.authorizingPrescription" title="Indicates the medication order that is being dispensed against."><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"> Medication order that authorizes the dispense</span><span style="color: Gray"> --></span></authorizingPrescription> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense" title="Indicates the details of the dispense event such as the days supply and quantity of medication dispensed."><b>dispense</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Details for individual dispensed medicationdetails --></span> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.identifier" title="Identifier assigned by the dispensing facility. This is an identifier assigned outside FHIR."><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> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.status" title="A code specifying the state of the dispense event (this element modifies the meaning of other elements)"><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 href="medication-dispense-status.html" style="color: navy">in progress | on hold | completed | entered in error | stopped</a></span><span style="color: Gray"> --></span> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.type" title="Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc."><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 href="v3/vs/ActPharmacySupplyType/index.html" style="color: navy">Trial fill, partial fill, emergency fill, etc.</a><span style="color: Gray"> --></span></type> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.quantity" title="The amount of medication that has been dispensed. Includes unit of measure."><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> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.medication" 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."><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> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.whenPrepared" title="The time when the dispensed product was packaged and reviewed."><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> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.whenHandedOver" title="The time the dispensed product was provided to the patient or their representative."><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> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.destination" title="Identification of the facility/location where the medication was shipped to, as part of the dispense event."><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> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.receiver" 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."><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> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.dosage" title="Indicates how the medication is to be used by the patient."><b>dosage</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Medicine administration instructions to the patient/carer --></span> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.dosage.additionalInstructions" title="Additional instructions such as "Swallow with plenty of water" which may or may not be coded."><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> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.dosage.timing_x_" 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"."><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]> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.dosage.asNeeded_x_" 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."><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]> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.dosage.site" title="A coded specification of the anatomic site where the medication first enters the body."><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 href="valueset-approach-site-codes.html" style="color: navy">Body site to administer to</a></span><span style="color: Gray"> --></span></site> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.dosage.route" title="A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject."><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 href="valueset-route-codes.html" style="color: navy">How drug should enter body</a></span><span style="color: Gray"> --></span></route> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.dosage.method" 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. Terminologies used often pre-coordinate this term with the route and or form of administration."><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 href="valueset-administration-method-codes.html" style="color: navy">Technique for administering medication</a></span><span style="color: Gray"> --></span></method> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.dosage.quantity" title="The amount of therapeutic or other substance given at one administration event."><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> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.dosage.rate" title="Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours."><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> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.dosage.maxDosePerPeriod" 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."><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> </dosage> </dispense> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.substitution" 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."><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> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.substitution.type" title="A code signifying whether a different drug was dispensed from what was prescribed."><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 href="v3/vs/ActSubstanceAdminSubstitutionCode/index.html" style="color: navy">Type of substitiution</a><span style="color: Gray"> --></span></type> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.substitution.reason" title="Indicates the reason for the substitution of (or lack of substitution) from what was prescribed."><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 href="v3/vs/SubstanceAdminSubstitutionReason/index.html" style="color: navy">Why was substitution made</a><span style="color: Gray"> --></span></reason> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.substitution.responsibleParty" title="The person or organization that has primary responsibility for the substitution."><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"> Who is responsible for the substitution</span><span style="color: Gray"> --></span></responsibleParty> </substitution> </MedicationDispense> </pre></div> </text> <name value="medicationdispense"/> <publisher value="FHIR Project"/> <description value="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 value="draft"/> <date value="2014-09-30"/> <requirements value="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 value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <structure> <type value="MedicationDispense"/> <publish value="true"/> <element> <path value="MedicationDispense"/> <definition> <short value="Dispensing a medication to a named patient"/> <formal value="Dispensing a medication to a named patient. This includes a description of the supply provided and the instructions for administering the medication."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Supply[moodCode=EVN]"/> </mapping> </definition> </element> <element> <path value="MedicationDispense.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MedicationDispense.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MedicationDispense.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MedicationDispense.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MedicationDispense.identifier"/> <definition> <short value="External identifier"/> <formal value="Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR."/> <min value="0"/> <max value="1"/> <type> <code value="Identifier"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> </definition> </element> <element> <path value="MedicationDispense.status"/> <definition> <short value="in progress | on hold | completed | entered in error | stopped"/> <formal value="A code specifying the state of the set of dispense events."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="MedicationDispenseStatus"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/medication-dispense-status"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".status"/> </mapping> <mapping> <identity value="v2"/> <map value="(Not clear whether or how V2 provides for a snapshot of dispense status)"/> </mapping> </definition> </element> <element> <path value="MedicationDispense.patient"/> <definition> <short value="Who the dispense is for"/> <formal value="A link to a resource representing the person to whom the medication will be given."/> <comments value="SubstanceAdministration->subject->Patient."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=SBJ].role[classCode=PAT]"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-3-Patient ID List"/> </mapping> </definition> </element> <element> <path value="MedicationDispense.dispenser"/> <definition> <short value="Practitioner responsible for dispensing medication"/> <formal value="The individual responsible for dispensing the medication."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=PFM].role[classCode=ASSIGN]"/> </mapping> <mapping> <identity value="v2"/> <map value="RXD-10-Dispensing Provider / PRT-5-Participation Person: PRT-4-Participation='DP' (RXD-10 is deprecated)"/> </mapping> </definition> </element> <element> <path value="MedicationDispense.authorizingPrescription"/> <definition> <short value="Medication order that authorizes the dispense"/> <formal value="Indicates the medication order that is being dispensed against."/> <min value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/MedicationPrescription"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=FLFS].target[moodCode=RQO]"/> </mapping> <mapping> <identity value="v2"/> <map value="ORC-3-Filler Order Number / ORC-2-Placer Order Number"/> </mapping> </definition> </element> <element> <path value="MedicationDispense.dispense"/> <definition> <short value="Details for individual dispensed medicationdetails"/> <formal value="Indicates the details of the dispense event such as the days supply and quantity of medication dispensed."/> <min value="0"/> <max value="*"/> <constraint> <key value="1"/> <name value="Timing"/> <severity value="error"/> <human value="whenHandedOver cannot be before whenPrepared"/> <xpath value="not(exists(f:whenHandedOver/@value)) or not(exists(f:whenPrepared/@value)) or ( f:whenHandedOver/@va lue >= f:whenPrepared/@value)"/> </constraint> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=COMP].target[classCode=SPLY, moodCode=EVN]"/> </mapping> </definition> </element> <element> <path value="MedicationDispense.dispense.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MedicationDispense.dispense.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MedicationDispense.dispense.identifier"/> <definition> <short value="External identifier for individual item"/> <formal value="Identifier assigned by the dispensing facility. This is an identifier assigned outside FHIR."/> <min value="0"/> <max value="1"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> </definition> </element> <element> <path value="MedicationDispense.dispense.status"/> <definition> <short value="in progress | on hold | completed | entered in error | stopped"/> <formal value="A code specifying the state of the dispense event."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="MedicationDispenseStatus"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/medication-dispense-status"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".status"/> </mapping> </definition> </element> <element> <path value="MedicationDispense.dispense.type"/> <definition> <short value="Trial fill, partial fill, emergency fill, etc."/> <formal value="Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="MedicationDispenseType"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/v3/vs/ActPharmacySupplyType"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> <mapping> <identity value="v2"/> <map value="RXD-33-Dispense Type"/> </mapping> </definition> </element> <element> <path value="MedicationDispense.dispense.quantity"/> <definition> <short value="Amount dispensed"/> <formal value="The amount of medication that has been dispensed. Includes unit of measure."/> <min value="0"/> <max value="1"/> <type> <code value="Quantity"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".quantity"/> </mapping> <mapping> <identity value="v2"/> <map value="RXD-4-Actual Dispense Amount / RXD-5.1-Actual Dispense Units.code / RXD-5.3-Actual Dispense Units.name of coding system"/> </mapping> </definition> </element> <element> <path value="MedicationDispense.dispense.medication"/> <definition> <short value="What medication was supplied"/> <formal value="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 value="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 value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Medication"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=PRD].role"/> </mapping> <mapping> <identity value="v2"/> <map value="RXD-2-Dispense/Give Code"/> </mapping> </definition> </element> <element> <path value="MedicationDispense.dispense.whenPrepared"/> <definition> <short value="Dispense processing time"/> <formal value="The time when the dispensed product was packaged and reviewed."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".effectiveTime[xmi:type=IVL_TS].low"/> </mapping> <mapping> <identity value="v2"/> <map value="RXD-3-Date/Time Dispensed"/> </mapping> </definition> </element> <element> <path value="MedicationDispense.dispense.whenHandedOver"/> <definition> <short value="Handover time"/> <formal value="The time the dispensed product was provided to the patient or their representative."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".effectiveTime[xmi:type=IVL_TS].high"/> </mapping> <mapping> <identity value="v2"/> <map value="RXD-3-Date/Time Dispensed"/> </mapping> </definition> </element> <element> <path value="MedicationDispense.dispense.destination"/> <definition> <short value="Where the medication was sent"/> <formal value="Identification of the facility/location where the medication was shipped to, as part of the dispense event."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Location"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=DST].role"/> </mapping> <mapping> <identity value="v2"/> <map value="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)"/> </mapping> </definition> </element> <element> <path value="MedicationDispense.dispense.receiver"/> <definition> <short value="Who collected the medication"/> <formal value="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 value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=RCV].role"/> </mapping> </definition> </element> <element> <path value="MedicationDispense.dispense.dosage"/> <definition> <short value="Medicine administration instructions to the patient/carer"/> <formal value="Indicates how the medication is to be used by the patient."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=COMP].target[classCode=SBADM, moodCode=INT]"/> </mapping> </definition> </element> <element> <path value="MedicationDispense.dispense.dosage.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MedicationDispense.dispense.dosage.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MedicationDispense.dispense.dosage.additionalInstructions"/> <definition> <short value="E.g. "Take with food""/> <formal value="Additional instructions such as "Swallow with plenty of water" which may or may not be coded."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".text"/> </mapping> </definition> </element> <element> <path value="MedicationDispense.dispense.dosage.timing[x]"/> <definition> <short value="When medication should be administered"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <type> <code value="Period"/> </type> <type> <code value="Schedule"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".effectiveTime"/> </mapping> <mapping> <identity value="v2"/> <map value="RDS:TQ1"/> </mapping> </definition> </element> <element> <path value="MedicationDispense.dispense.dosage.asNeeded[x]"/> <definition> <short value="Take "as needed" f(or x)"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="MedicationAsNeededReason"/> <isExtensible value="true"/> <conformance value="preferred"/> <description value="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."/> </binding> <mapping> <identity value="rim"/> <map value="boolean: .outboundRelationship[typeCode=PRCN].negationInd (inversed - so negationInd = true means asNeeded=false CodeableConcept: .outboundRelationship[typCode=PRCN].target[classCode=OBS , moodCode=EVN, isCriterionInd=true, code="Assertion"].value"/> </mapping> </definition> </element> <element> <path value="MedicationDispense.dispense.dosage.site"/> <definition> <short value="Body site to administer to"/> <formal value="A coded specification of the anatomic site where the medication first enters the body."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="MedicationAdministrationSite"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/approach-site-codes"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".approachSiteCode"/> </mapping> <mapping> <identity value="v2"/> <map value="RXR-2-Administration Site"/> </mapping> </definition> </element> <element> <path value="MedicationDispense.dispense.dosage.route"/> <definition> <short value="How drug should enter body"/> <formal value="A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="RouteOfAdministration"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/route-codes"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".routeCode"/> </mapping> <mapping> <identity value="v2"/> <map value="RXR-1-Route"/> </mapping> </definition> </element> <element> <path value="MedicationDispense.dispense.dosage.method"/> <definition> <short value="Technique for administering medication"/> <formal value="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. Terminologies used often pre-coordinate this term with the route and or form of administration."/> <comments value="SubstanceAdministration.methodCode."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="MedicationAdministrationMethod"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/administration-method-codes"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".methodCode"/> </mapping> <mapping> <identity value="v2"/> <map value="RXR-4-Administration Method"/> </mapping> </definition> </element> <element> <path value="MedicationDispense.dispense.dosage.quantity"/> <definition> <short value="Amount of medication per dose"/> <formal value="The amount of therapeutic or other substance given at one administration event."/> <min value="0"/> <max value="1"/> <type> <code value="Quantity"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".doseQuantity"/> </mapping> <mapping> <identity value="v2"/> <map value="RXE-23-Give Rate Amount / RXE-24.1-Give Rate Units.code / RXE-24.3-Give Rate Units.name of coding system"/> </mapping> </definition> </element> <element> <path value="MedicationDispense.dispense.dosage.rate"/> <definition> <short value="Amount of medication per unit of time"/> <formal value="Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours."/> <min value="0"/> <max value="1"/> <type> <code value="Ratio"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".rateQuantity"/> </mapping> <mapping> <identity value="v2"/> <map value="RXE-22-Give Per (Time Unit)"/> </mapping> </definition> </element> <element> <path value="MedicationDispense.dispense.dosage.maxDosePerPeriod"/> <definition> <short value="Upper limit on medication per unit of time"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="Ratio"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".maxDoseQuantity"/> </mapping> <mapping> <identity value="v2"/> <map value="RXE-4-Give Amount - Maximum / RXE-5-Give Units"/> </mapping> </definition> </element> <element> <path value="MedicationDispense.substitution"/> <definition> <short value="Deals with substitution of one medicine for another"/> <formal value="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 value="0"/> <max value="1"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=COMP].target[classCode=SUBST, moodCode=EVN]"/> </mapping> </definition> </element> <element> <path value="MedicationDispense.substitution.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MedicationDispense.substitution.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MedicationDispense.substitution.type"/> <definition> <short value="Type of substitiution"/> <formal value="A code signifying whether a different drug was dispensed from what was prescribed."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="MedicationIntendedSubstitutionType"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/v3/vs/ActSubstanceAdminSubstitutionCode"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> <mapping> <identity value="v2"/> <map value="RXE-9-Substitution Status? (perhaps RXO-9-Allow Substitutions?)"/> </mapping> </definition> </element> <element> <path value="MedicationDispense.substitution.reason"/> <definition> <short value="Why was substitution made"/> <formal value="Indicates the reason for the substitution of (or lack of substitution) from what was prescribed."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="MedicationIntendedSubstitutionReason"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/v3/vs/SubstanceAdminSubstitutionReason"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".reasonCode"/> </mapping> </definition> </element> <element> <path value="MedicationDispense.substitution.responsibleParty"/> <definition> <short value="Who is responsible for the substitution"/> <formal value="The person or organization that has primary responsibility for the substitution."/> <comments value="rename."/> <min value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=PFM].role[classCode=ASSIGN]"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="destination"/> <type value="reference"/> <documentation value="Return dispenses that should be sent to a secific destination"/> <xpath value="f:MedicationDispense/f:dispense/f:destination"/> </searchParam> <searchParam> <name value="dispenser"/> <type value="reference"/> <documentation value="Return all dispenses performed by a specific indiividual"/> <xpath value="f:MedicationDispense/f:dispenser"/> </searchParam> <searchParam> <name value="identifier"/> <type value="token"/> <documentation value="Return dispenses with this external identity"/> <xpath value="f:MedicationDispense/f:identifier"/> </searchParam> <searchParam> <name value="medication"/> <type value="reference"/> <documentation value="Returns dispenses of this medicine"/> <xpath value="f:MedicationDispense/f:dispense/f:medication"/> </searchParam> <searchParam> <name value="patient"/> <type value="reference"/> <documentation value="The identity of a patient to list dispenses for"/> <xpath value="f:MedicationDispense/f:patient"/> </searchParam> <searchParam> <name value="prescription"/> <type value="reference"/> <documentation value="The identity of a prescription to list dispenses from"/> <xpath value="f:MedicationDispense/f:authorizingPrescription"/> </searchParam> <searchParam> <name value="responsibleparty"/> <type value="reference"/> <documentation value="Return all dispenses with the specified responsible party"/> <xpath value="f:MedicationDispense/f:substitution/f:responsibleParty"/> </searchParam> <searchParam> <name value="status"/> <type value="token"/> <documentation value="Status of the dispense"/> <xpath value="f:MedicationDispense/f:dispense/f:status"/> </searchParam> <searchParam> <name value="type"/> <type value="token"/> <documentation value="Return all dispenses of a specific type"/> <xpath value="f:MedicationDispense/f:dispense/f:type"/> </searchParam> <searchParam> <name value="whenhandedover"/> <type value="date"/> <documentation value="Date when medication handed over to patient (outpatient setting), or supplied to ward or clinic (inpatient setting)"/> <xpath value="f:MedicationDispense/f:dispense/f:whenHandedOver"/> </searchParam> <searchParam> <name value="whenprepared"/> <type value="date"/> <documentation value="Date when medication prepared"/> <xpath value="f:MedicationDispense/f:dispense/f:whenPrepared"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense" title="Dispensing a medication to a named patient. This includes a description of the supply provided and the instructions for administering the medication."><b>MedicationDispense</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.identifier" title="Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR (this element modifies the meaning of other elements)"><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> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.status" title="A code specifying the state of the set of dispense events (this element modifies the meaning of other elements)"><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 href="medication-dispense-status.html" style="color: navy">in progress | on hold | completed | entered in error | stopped</a></span><span style="color: Gray"> --></span> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.patient" title="A link to a resource representing the person to whom the medication will be given."><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> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispenser" title="The individual responsible for dispensing the medication."><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"> Practitioner responsible for dispensing medication</span><span style="color: Gray"> --></span></dispenser> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.authorizingPrescription" title="Indicates the medication order that is being dispensed against."><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"> Medication order that authorizes the dispense</span><span style="color: Gray"> --></span></authorizingPrescription> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense" title="Indicates the details of the dispense event such as the days supply and quantity of medication dispensed."><b>dispense</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Details for individual dispensed medicationdetails --></span> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.identifier" title="Identifier assigned by the dispensing facility. This is an identifier assigned outside FHIR."><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> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.status" title="A code specifying the state of the dispense event (this element modifies the meaning of other elements)"><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 href="medication-dispense-status.html" style="color: navy">in progress | on hold | completed | entered in error | stopped</a></span><span style="color: Gray"> --></span> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.type" title="Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc."><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 href="v3/vs/ActPharmacySupplyType/index.html" style="color: navy">Trial fill, partial fill, emergency fill, etc.</a><span style="color: Gray"> --></span></type> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.quantity" title="The amount of medication that has been dispensed. Includes unit of measure."><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> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.medication" 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."><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> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.whenPrepared" title="The time when the dispensed product was packaged and reviewed."><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> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.whenHandedOver" title="The time the dispensed product was provided to the patient or their representative."><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> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.destination" title="Identification of the facility/location where the medication was shipped to, as part of the dispense event."><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> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.receiver" 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."><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> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.dosage" title="Indicates how the medication is to be used by the patient."><b>dosage</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Medicine administration instructions to the patient/carer --></span> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.dosage.additionalInstructions" title="Additional instructions such as "Swallow with plenty of water" which may or may not be coded."><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> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.dosage.timing_x_" 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"."><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]> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.dosage.asNeeded_x_" 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."><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]> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.dosage.site" title="A coded specification of the anatomic site where the medication first enters the body."><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 href="valueset-approach-site-codes.html" style="color: navy">Body site to administer to</a></span><span style="color: Gray"> --></span></site> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.dosage.route" title="A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject."><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 href="valueset-route-codes.html" style="color: navy">How drug should enter body</a></span><span style="color: Gray"> --></span></route> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.dosage.method" 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. Terminologies used often pre-coordinate this term with the route and or form of administration."><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 href="valueset-administration-method-codes.html" style="color: navy">Technique for administering medication</a></span><span style="color: Gray"> --></span></method> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.dosage.quantity" title="The amount of therapeutic or other substance given at one administration event."><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> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.dosage.rate" title="Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours."><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> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.dispense.dosage.maxDosePerPeriod" 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."><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> </dosage> </dispense> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.substitution" 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."><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> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.substitution.type" title="A code signifying whether a different drug was dispensed from what was prescribed."><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 href="v3/vs/ActSubstanceAdminSubstitutionCode/index.html" style="color: navy">Type of substitiution</a><span style="color: Gray"> --></span></type> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.substitution.reason" title="Indicates the reason for the substitution of (or lack of substitution) from what was prescribed."><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 href="v3/vs/SubstanceAdminSubstitutionReason/index.html" style="color: navy">Why was substitution made</a><span style="color: Gray"> --></span></reason> <<a class="dict" href="medicationdispense-definitions.html#MedicationDispense.substitution.responsibleParty" title="The person or organization that has primary responsibility for the substitution."><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"> Who is responsible for the substitution</span><span style="color: Gray"> --></span></responsibleParty> </substitution> </MedicationDispense> </pre></div> </summary> </entry> <entry> <title>"medicationprescription" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/medicationprescription</id> <link href="http://hl7.org/implement/standards/fhir/medicationprescription.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription" title="An order for both supply of the medication and the instructions for administration of the medicine to a patient."><b>MedicationPrescription</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.identifier" 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)"><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> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dateWritten" title="The date (and perhaps time) when the prescription was written."><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> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.status" 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)"><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 href="medication-prescription-status.html" style="color: navy">active | on hold | completed | entered in error | stopped | superceded</a></span><span style="color: Gray"> --></span> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.patient" title="A link to a resource representing the person to whom the medication will be given."><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> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.prescriber" title="The healthcare professional responsible for authorizing the prescription."><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> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.encounter" title="A link to a resource that identifies the particular occurrence of contact between patient and health care provider."><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> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.reason_x_" title="Can be the reason or the indication for writing the prescription."><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"> Reason or indication for writing the prescription</span><span style="color: Gray"> --></span></reason[x]> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.medication" 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."><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> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dosageInstruction" title="Indicates how the medication is to be used by the patient."><b>dosageInstruction</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> How medication should be taken --></span> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.text" title="Free text dosage instructions for cases where the instructions are too complex to code."><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> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.additionalInstructi ons" title="Additional instructions such as "Swallow with plenty of water" which may or may not be coded."><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"> Supplemental instructions - e.g. "with meals"</span><span style="color: Gray"> --></span></additionalInstructions> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.timing_x_" 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"."><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]> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.asNeeded_x_" 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."><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]> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.site" title="A coded specification of the anatomic site where the medication first enters the body."><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 href="valueset-approach-site-codes.html" style="color: navy">Body site to administer to</a></span><span style="color: Gray"> --></span></site> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.route" title="A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient."><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 href="valueset-route-codes.html" style="color: navy">How drug should enter body</a></span><span style="color: Gray"> --></span></route> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.method" 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. Terminologies used often pre-coordinate this term with the route and or form of administration."><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 href="valueset-administration-method-codes.html" style="color: navy">Technique for administering medication</a></span><span style="color: Gray"> --></span></method> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.doseQuantity" title="The amount of therapeutic or other substance given at one administration event."><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> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.rate" title="Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours."><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> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.maxDosePerPeriod" 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."><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> </dosageInstruction> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dispense" title="Deals with details of the dispense part of the order."><b>dispense</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..1</b></span> Medication supply authorization --></span> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dispense.medication" 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."><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> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dispense.validityPeriod" title="Design Comments: This indicates the validity period of a prescription (stale dating the Prescription) It 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. Rationale: Indicates when the Prescription becomes valid, and when it ceases to be a dispensable Prescription."><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> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dispense.numberOfRepeatsAllowed" title="An integer indicating the number of repeats of the Dispense. UsageNotes: For example, the number of times the prescribed quantity is to be supplied including the initial standard fill."><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> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dispense.quantity" title="The amount that is to be dispensed."><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> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dispense.expectedSupplyDuration" 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. In 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."><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> </dispense> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.substitution" 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."><b>substitution</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..1</b></span> Any restrictions on medication substitution? --></span> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.substitution.type" title="A code signifying whether a different drug should be dispensed from what was prescribed."><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 href="v3/vs/ActSubstanceAdminSubstitutionCode/index.html" style="color: navy">generic | formulary +</a><span style="color: Gray"> --></span></type> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.substitution.reason" title="Indicates the reason for the substitution, or why substitution must or must not be performed."><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 href="v3/vs/SubstanceAdminSubstitutionReason/index.html" style="color: navy">Why should substitution (not) be made</a><span style="color: Gray"> --></span></reason> </substitution> </MedicationPrescription> </pre></div> </text> <name value="medicationprescription"/> <publisher value="FHIR Project"/> <description value="Basic Profile. An order for both supply of the medication and the instructions for administration of the medicine to a patient."/> <status value="draft"/> <date value="2014-09-30"/> <requirements value="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 value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <structure> <type value="MedicationPrescription"/> <publish value="true"/> <element> <path value="MedicationPrescription"/> <definition> <short value="Prescription of medication to for patient"/> <formal value="An order for both supply of the medication and the instructions for administration of the medicine to a patient."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="CombinedMedicationRequest"/> </mapping> </definition> </element> <element> <path value="MedicationPrescription.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MedicationPrescription.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MedicationPrescription.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MedicationPrescription.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MedicationPrescription.identifier"/> <definition> <short value="External identifier"/> <formal value="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 value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="id"/> </mapping> <mapping> <identity value="v2"/> <map value="ORC-2-Placer Order Number / ORC-3-Filler Order Number"/> </mapping> </definition> </element> <element> <path value="MedicationPrescription.dateWritten"/> <definition> <short value="When prescription was authorized"/> <formal value="The date (and perhaps time) when the prescription was written."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="author.time"/> </mapping> <mapping> <identity value="v2"/> <map value="RXE-32-Original Order Date/Time / ORC-9-Date/Time of Transaction"/> </mapping> </definition> </element> <element> <path value="MedicationPrescription.status"/> <definition> <short value="active | on hold | completed | entered in error | stopped | superceded"/> <formal value="A code specifying the state of the order. Generally this will be active or completed state."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="MedicationPrescriptionStatus"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/medication-prescription-status"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="statusCode"/> </mapping> </definition> </element> <element> <path value="MedicationPrescription.patient"/> <definition> <short value="Who prescription is for"/> <formal value="A link to a resource representing the person to whom the medication will be given."/> <comments value="SubstanceAdministration->subject->Patient."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="subject.role"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-3-Patient ID List"/> </mapping> </definition> </element> <element> <path value="MedicationPrescription.prescriber"/> <definition> <short value="Who ordered the medication(s)"/> <formal value="The healthcare professional responsible for authorizing the prescription."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="author.role"/> </mapping> <mapping> <identity value="v2"/> <map value="RXE-13-Ordering Provider's DEA Number / RXO-14-Ordering Provider's DEA Number / RXE-14-Pharmacist/Tr eatment 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)"/> </mapping> </definition> </element> <element> <path value="MedicationPrescription.encounter"/> <definition> <short value="Created during encounter / admission / stay"/> <formal value="A link to a resource that identifies the particular occurrence of contact between patient and health care provider."/> <comments value="SubstanceAdministration->component->EncounterEvent."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Encounter"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="componentOf.patientEncounter"/> </mapping> <mapping> <identity value="v2"/> <map value="PV1-19-Visit Number"/> </mapping> </definition> </element> <element> <path value="MedicationPrescription.reason[x]"/> <definition> <short value="Reason or indication for writing the prescription"/> <formal value="Can be the reason or the indication for writing the prescription."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Condition"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="reason.observation or reason.observation[code=ASSERTION].value"/> </mapping> <mapping> <identity value="v2"/> <map value="ORC-16-Order Control Code Reason"/> </mapping> </definition> </element> <element> <path value="MedicationPrescription.medication"/> <definition> <short value="Medication to be taken"/> <formal value="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 value="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 value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Medication"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="consumable.administrableMedication"/> </mapping> <mapping> <identity value="v2"/> <map value="RXE-2-Give Code / RXO-1-Requested Give Code / RXD-2-Dispense/Give Code"/> </mapping> </definition> </element> <element> <path value="MedicationPrescription.dosageInstruction"/> <definition> <short value="How medication should be taken"/> <formal value="Indicates how the medication is to be used by the patient."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="component.substanceAdministrationRequest"/> </mapping> </definition> </element> <element> <path value="MedicationPrescription.dosageInstruction.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MedicationPrescription.dosageInstruction.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MedicationPrescription.dosageInstruction.text"/> <definition> <short value="Dosage instructions expressed as text"/> <formal value="Free text dosage instructions for cases where the instructions are too complex to code."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="text"/> </mapping> <mapping> <identity value="v2"/> <map value="RXE-7.2-Provider's Administration Instructions.text / RXO-7.2-Provider's Administration Instructions.text / TQ1-10-Condition Text / TQ1-11-Text Instruction"/> </mapping> </definition> </element> <element> <path value="MedicationPrescription.dosageInstruction.additionalInstructions"/> <definition> <short value="Supplemental instructions - e.g. "with meals""/> <formal value="Additional instructions such as "Swallow with plenty of water" which may or may not be coded."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="component.substanceAdministrationRequest.text"/> </mapping> <mapping> <identity value="v2"/> <map value="RXE-7.2-Provider's Administration Instructions.text / RXO-7.2-Provider's Administration Instructions.text / TQ1-10-Condition Text / TQ1-11-Text Instruction ?"/> </mapping> </definition> </element> <element> <path value="MedicationPrescription.dosageInstruction.timing[x]"/> <definition> <short value="When medication should be administered"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <type> <code value="Period"/> </type> <type> <code value="Schedule"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="effectiveTime"/> </mapping> <mapping> <identity value="v2"/> <map value="RDS:TQ1"/> </mapping> </definition> </element> <element> <path value="MedicationPrescription.dosageInstruction.asNeeded[x]"/> <definition> <short value="Take "as needed" f(or x)"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="MedicationAsNeededReason"/> <isExtensible value="true"/> <conformance value="preferred"/> <description value="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."/> </binding> <mapping> <identity value="rim"/> <map value="boolean: precondition.negationInd (inversed - so negationInd = true means asNeeded=false CodeableConcept: precondition.observationEventCriterion[code="Assertion"].value"/> </mapping> </definition> </element> <element> <path value="MedicationPrescription.dosageInstruction.site"/> <definition> <short value="Body site to administer to"/> <formal value="A coded specification of the anatomic site where the medication first enters the body."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="MedicationAdministrationSite"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/approach-site-codes"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="approachSiteCode"/> </mapping> <mapping> <identity value="v2"/> <map value="RXR-2-Administration Site"/> </mapping> </definition> </element> <element> <path value="MedicationPrescription.dosageInstruction.route"/> <definition> <short value="How drug should enter body"/> <formal value="A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="RouteOfAdministration"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/route-codes"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="routeCode"/> </mapping> <mapping> <identity value="v2"/> <map value="RXR-1-Route"/> </mapping> </definition> </element> <element> <path value="MedicationPrescription.dosageInstruction.method"/> <definition> <short value="Technique for administering medication"/> <formal value="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. Terminologies used often pre-coordinate this term with the route and or form of administration."/> <comments value="SubstanceAdministration.methodCode."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="MedicationAdministrationMethod"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/administration-method-codes"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="methodCode"/> </mapping> <mapping> <identity value="v2"/> <map value="RXR-4-Administration Method"/> </mapping> </definition> </element> <element> <path value="MedicationPrescription.dosageInstruction.doseQuantity"/> <definition> <short value="Amount of medication per dose"/> <formal value="The amount of therapeutic or other substance given at one administration event."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="Quantity"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="doseQuantity"/> </mapping> <mapping> <identity value="v2"/> <map value="RXE-23-Give Rate Amount / RXE-24.1-Give Rate Units.code / RXE-24.3-Give Rate Units.name of coding system"/> </mapping> </definition> </element> <element> <path value="MedicationPrescription.dosageInstruction.rate"/> <definition> <short value="Amount of medication per unit of time"/> <formal value="Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours."/> <min value="0"/> <max value="1"/> <type> <code value="Ratio"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="rateQuantity"/> </mapping> <mapping> <identity value="v2"/> <map value="RXE-22-Give Per (Time Unit)"/> </mapping> </definition> </element> <element> <path value="MedicationPrescription.dosageInstruction.maxDosePerPeriod"/> <definition> <short value="Upper limit on medication per unit of time"/> <formal value="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 value="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 value="0"/> <max value="1"/> <type> <code value="Ratio"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="maxDoseQuantity"/> </mapping> <mapping> <identity value="v2"/> <map value="RXE-4-Give Amount - Maximum / RXE-5-Give Units"/> </mapping> </definition> </element> <element> <path value="MedicationPrescription.dispense"/> <definition> <short value="Medication supply authorization"/> <formal value="Deals with details of the dispense part of the order."/> <min value="0"/> <max value="1"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="component.supplyEvent"/> </mapping> </definition> </element> <element> <path value="MedicationPrescription.dispense.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MedicationPrescription.dispense.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MedicationPrescription.dispense.medication"/> <definition> <short value="Product to be supplied"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Medication"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="consumable.role"/> </mapping> <mapping> <identity value="v2"/> <map value="RXE-2-Give Code / RXO-1-Requested Give Code / RXD-2-Dispense/Give Code"/> </mapping> </definition> </element> <element> <path value="MedicationPrescription.dispense.validityPeriod"/> <definition> <short value="Time period supply is authorized for"/> <formal value="Design Comments: This indicates the validity period of a prescription (stale dating the Prescription) It 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. Rationale: Indicates when the Prescription becomes valid, and when it ceases to be a dispensable Prescription."/> <min value="0"/> <max value="1"/> <type> <code value="Period"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="effectiveTime"/> </mapping> <mapping> <identity value="v2"/> <map value="RXD-3-Date/Time Dispensed ? / RXD-19-Substance Expiration Date"/> </mapping> </definition> </element> <element> <path value="MedicationPrescription.dispense.numberOfRepeatsAllowed"/> <definition> <short value="# of refills authorized"/> <formal value="An integer indicating the number of repeats of the Dispense. UsageNotes: For example, the number of times the prescribed quantity is to be supplied including the initial standard fill."/> <comments value="If displaying "number of authorized refills", subtract 1 from this number."/> <min value="0"/> <max value="1"/> <type> <code value="integer"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="repeatNumber"/> </mapping> <mapping> <identity value="v2"/> <map value="RXE-12-Number of Refills"/> </mapping> </definition> </element> <element> <path value="MedicationPrescription.dispense.quantity"/> <definition> <short value="Amount of medication to supply per dispense"/> <formal value="The amount that is to be dispensed."/> <min value="0"/> <max value="1"/> <type> <code value="Quantity"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="quantity"/> </mapping> <mapping> <identity value="v2"/> <map value="RXD-4-Actual Dispense Amount / RXD-5.1-Actual Dispense Units.code / RXD-5.3-Actual Dispense Units.name of coding system"/> </mapping> </definition> </element> <element> <path value="MedicationPrescription.dispense.expectedSupplyDuration"/> <definition> <short value="Days supply per dispense"/> <formal value="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. In 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 value="0"/> <max value="1"/> <type> <code value="Duration"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="expectedUseTime"/> </mapping> </definition> </element> <element> <path value="MedicationPrescription.substitution"/> <definition> <short value="Any restrictions on medication substitution?"/> <formal value="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 value="0"/> <max value="1"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="subjectOf.substitutionPersmission"/> </mapping> </definition> </element> <element> <path value="MedicationPrescription.substitution.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MedicationPrescription.substitution.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MedicationPrescription.substitution.type"/> <definition> <short value="generic | formulary +"/> <formal value="A code signifying whether a different drug should be dispensed from what was prescribed."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="MedicationIntendedSubstitutionType"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/v3/vs/ActSubstanceAdminSubstitutionCode"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="code"/> </mapping> <mapping> <identity value="v2"/> <map value="RXO-9-Allow Substitutions / RXE-9-Substitution Status?"/> </mapping> </definition> </element> <element> <path value="MedicationPrescription.substitution.reason"/> <definition> <short value="Why should substitution (not) be made"/> <formal value="Indicates the reason for the substitution, or why substitution must or must not be performed."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="MedicationIntendedSubstitutionReason"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/v3/vs/SubstanceAdminSubstitutionReason"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="reasonCode"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="datewritten"/> <type value="date"/> <documentation value="Return prescriptions written on this date"/> <xpath value="f:MedicationPrescription/f:dateWritten"/> </searchParam> <searchParam> <name value="encounter"/> <type value="reference"/> <documentation value="Return prescriptions with this encounter identity"/> <xpath value="f:MedicationPrescription/f:encounter"/> </searchParam> <searchParam> <name value="identifier"/> <type value="token"/> <documentation value="Return prescriptions with this external identity"/> <xpath value="f:MedicationPrescription/f:identifier"/> </searchParam> <searchParam> <name value="medication"/> <type value="reference"/> <documentation value="Code for medicine or text in medicine name"/> <xpath value="f:MedicationPrescription/f:medication"/> </searchParam> <searchParam> <name value="patient"/> <type value="reference"/> <documentation value="The identity of a patient to list dispenses for"/> <xpath value="f:MedicationPrescription/f:patient"/> </searchParam> <searchParam> <name value="status"/> <type value="token"/> <documentation value="Status of the prescription"/> <xpath value="f:MedicationPrescription/f:status"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription" title="An order for both supply of the medication and the instructions for administration of the medicine to a patient."><b>MedicationPrescription</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.identifier" 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)"><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> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dateWritten" title="The date (and perhaps time) when the prescription was written."><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> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.status" 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)"><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 href="medication-prescription-status.html" style="color: navy">active | on hold | completed | entered in error | stopped | superceded</a></span><span style="color: Gray"> --></span> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.patient" title="A link to a resource representing the person to whom the medication will be given."><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> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.prescriber" title="The healthcare professional responsible for authorizing the prescription."><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> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.encounter" title="A link to a resource that identifies the particular occurrence of contact between patient and health care provider."><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> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.reason_x_" title="Can be the reason or the indication for writing the prescription."><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"> Reason or indication for writing the prescription</span><span style="color: Gray"> --></span></reason[x]> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.medication" 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."><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> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dosageInstruction" title="Indicates how the medication is to be used by the patient."><b>dosageInstruction</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> How medication should be taken --></span> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.text" title="Free text dosage instructions for cases where the instructions are too complex to code."><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> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.additionalInstructi ons" title="Additional instructions such as "Swallow with plenty of water" which may or may not be coded."><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"> Supplemental instructions - e.g. "with meals"</span><span style="color: Gray"> --></span></additionalInstructions> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.timing_x_" 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"."><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]> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.asNeeded_x_" 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."><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]> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.site" title="A coded specification of the anatomic site where the medication first enters the body."><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 href="valueset-approach-site-codes.html" style="color: navy">Body site to administer to</a></span><span style="color: Gray"> --></span></site> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.route" title="A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient."><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 href="valueset-route-codes.html" style="color: navy">How drug should enter body</a></span><span style="color: Gray"> --></span></route> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.method" 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. Terminologies used often pre-coordinate this term with the route and or form of administration."><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 href="valueset-administration-method-codes.html" style="color: navy">Technique for administering medication</a></span><span style="color: Gray"> --></span></method> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.doseQuantity" title="The amount of therapeutic or other substance given at one administration event."><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> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.rate" title="Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours."><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> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.maxDosePerPeriod" 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."><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> </dosageInstruction> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dispense" title="Deals with details of the dispense part of the order."><b>dispense</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..1</b></span> Medication supply authorization --></span> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dispense.medication" 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."><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> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dispense.validityPeriod" title="Design Comments: This indicates the validity period of a prescription (stale dating the Prescription) It 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. Rationale: Indicates when the Prescription becomes valid, and when it ceases to be a dispensable Prescription."><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> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dispense.numberOfRepeatsAllowed" title="An integer indicating the number of repeats of the Dispense. UsageNotes: For example, the number of times the prescribed quantity is to be supplied including the initial standard fill."><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> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dispense.quantity" title="The amount that is to be dispensed."><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> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.dispense.expectedSupplyDuration" 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. In 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."><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> </dispense> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.substitution" 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."><b>substitution</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..1</b></span> Any restrictions on medication substitution? --></span> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.substitution.type" title="A code signifying whether a different drug should be dispensed from what was prescribed."><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 href="v3/vs/ActSubstanceAdminSubstitutionCode/index.html" style="color: navy">generic | formulary +</a><span style="color: Gray"> --></span></type> <<a class="dict" href="medicationprescription-definitions.html#MedicationPrescription.substitution.reason" title="Indicates the reason for the substitution, or why substitution must or must not be performed."><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 href="v3/vs/SubstanceAdminSubstitutionReason/index.html" style="color: navy">Why should substitution (not) be made</a><span style="color: Gray"> --></span></reason> </substitution> </MedicationPrescription> </pre></div> </summary> </entry> <entry> <title>"medicationstatement" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/medicationstatement</id> <link href="http://hl7.org/implement/standards/fhir/medicationstatement.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="medicationstatement-definitions.html#MedicationStatement" 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."><b>MedicationStatement</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="medicationstatement-definitions.html#MedicationStatement.identifier" 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)"><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> <<a class="dict" href="medicationstatement-definitions.html#MedicationStatement.patient" title="The person or animal who is /was taking the medication."><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> <<a class="dict" href="medicationstatement-definitions.html#MedicationStatement.wasNotGiven" title="Set this to true if the record is saying that the medication was NOT taken."><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> <<a class="dict" href="medicationstatement-definitions.html#MedicationStatement.reasonNotGiven" title="A code indicating why the medication was not taken."><b>reasonNotGiven</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: Reason not given is only permitted if wasNotGiven is true"><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 href="valueset-reason-medication-not-given-codes.html" style="color: navy">True if asserting medication was not given</a></span><span style="color: Gray"> --></span></reasonNotGiven> <<a class="dict" href="medicationstatement-definitions.html#MedicationStatement.whenGiven" title="The interval of time during which it is being asserted that the patient was taking the medication."><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> <<a class="dict" href="medicationstatement-definitions.html#MedicationStatement.medication" 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."><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> <<a class="dict" href="medicationstatement-definitions.html#MedicationStatement.device" title="An identifier or a link to a resource that identifies a device used in administering the medication to the patient."><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> <<a class="dict" href="medicationstatement-definitions.html#MedicationStatement.dosage" title="Indicates how the medication is/was used by the patient."><b>dosage</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Details of how medication was taken --></span> <<a class="dict" href="medicationstatement-definitions.html#MedicationStatement.dosage.timing" 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"."><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> <<a class="dict" href="medicationstatement-definitions.html#MedicationStatement.dosage.asNeeded_x_" 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."><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]> <<a class="dict" href="medicationstatement-definitions.html#MedicationStatement.dosage.site" title="A coded specification of the anatomic site where the medication first enters the body."><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 href="valueset-approach-site-codes.html" style="color: navy">Where on body was medication administered?</a></span><span style="color: Gray"> --></span></site> <<a class="dict" href="medicationstatement-definitions.html#MedicationStatement.dosage.route" title="A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject."><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 href="valueset-route-codes.html" style="color: navy">How did the medication enter the body?</a></span><span style="color: Gray"> --></span></route> <<a class="dict" href="medicationstatement-definitions.html#MedicationStatement.dosage.method" 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. Terminologies used often pre-coordinate this term with the route and or form of administration."><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 href="valueset-administration-method-codes.html" style="color: navy">Technique used to administer medication</a></span><span style="color: Gray"> --></span></method> <<a class="dict" href="medicationstatement-definitions.html#MedicationStatement.dosage.quantity" title="The amount of therapeutic or other substance given at one administration event."><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> <<a class="dict" href="medicationstatement-definitions.html#MedicationStatement.dosage.rate" title="Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours."><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> <<a class="dict" href="medicationstatement-definitions.html#MedicationStatement.dosage.maxDosePerPeriod" 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."><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"> Maximum dose that was consumed per unit of time</span><span style="color: Gray"> --></span></maxDosePerPeriod> </dosage> </MedicationStatement> </pre></div> </text> <name value="medicationstatement"/> <publisher value="FHIR Project"/> <description value="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 value="draft"/> <date value="2014-09-30"/> <requirements value="Scope and Usage Common usage includes: * the recording of non-prescription and/or recreational drugs * the recording of an intake medication list upon admission to hospital * the summarization of a patient's "active medications" in a patient profile"/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <structure> <type value="MedicationStatement"/> <publish value="true"/> <element> <path value="MedicationStatement"/> <definition> <short value="Administration of medication to a patient"/> <formal value="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 value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <constraint> <key value="1"/> <name value="Not given reason"/> <severity value="error"/> <human value="Reason not given is only permitted if wasNotGiven is true"/> <xpath value="not(exists(f:reasonNotGiven)) or f:wasNotGiven='true'"/> </constraint> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="SubstanceAdministration"/> </mapping> </definition> </element> <element> <path value="MedicationStatement.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MedicationStatement.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MedicationStatement.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MedicationStatement.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MedicationStatement.identifier"/> <definition> <short value="External Identifier"/> <formal value="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 value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="SubstanceAdministration.id"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-25-Administered Barcode Identifier?"/> </mapping> </definition> </element> <element> <path value="MedicationStatement.patient"/> <definition> <short value="Who was/is taking medication"/> <formal value="The person or animal who is /was taking the medication."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="SubstanceAdministration->subject->Patient"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-3-Patient ID List"/> </mapping> </definition> </element> <element> <path value="MedicationStatement.wasNotGiven"/> <definition> <short value="True if medication is/was not being taken"/> <formal value="Set this to true if the record is saying that the medication was NOT taken."/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="SubstanceAdministration.actionNegationInd"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-20-Completion Status='NA'"/> </mapping> </definition> </element> <element> <path value="MedicationStatement.reasonNotGiven"/> <definition> <short value="True if asserting medication was not given"/> <formal value="A code indicating why the medication was not taken."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="MedicationAdministrationNegationReason"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/reason-medication-not-given-codes"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="SubstanceAdministration->Reason->Observation->Value"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-9-Administration Notes:RXA-20-Completion Status='NA'"/> </mapping> </definition> </element> <element> <path value="MedicationStatement.whenGiven"/> <definition> <short value="Over what period was medication consumed?"/> <formal value="The interval of time during which it is being asserted that the patient was taking the medication."/> <comments value="If the medication is still being taken at the time the statement is recorded, the "end" date will be omitted."/> <min value="0"/> <max value="1"/> <type> <code value="Period"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="SubstanceAdministration.effectiveTime"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-3-Date/Time Start of Administration / RXA-4-Date/Time End of Administration"/> </mapping> </definition> </element> <element> <path value="MedicationStatement.medication"/> <definition> <short value="What medication was taken?"/> <formal value="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 value="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 value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Medication"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="SubstanceAdministration>Component>SubstanceAdministrationRequest.consumable"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-5-Administered Code"/> </mapping> </definition> </element> <element> <path value="MedicationStatement.device"/> <definition> <short value="E.g. infusion pump"/> <formal value="An identifier or a link to a resource that identifies a device used in administering the medication to the patient."/> <min value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Device"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="SubstanceAdministration->device->Access OR SubstanceAdministration->device->AssignedDev ice"/> </mapping> <mapping> <identity value="v2"/> <map value="PRT-10-Participation Device"/> </mapping> </definition> </element> <element> <path value="MedicationStatement.dosage"/> <definition> <short value="Details of how medication was taken"/> <formal value="Indicates how the medication is/was used by the patient."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="SubstanceAdministration>Component>SubstanceAdministrationRequest"/> </mapping> </definition> </element> <element> <path value="MedicationStatement.dosage.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MedicationStatement.dosage.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MedicationStatement.dosage.timing"/> <definition> <short value="When/how often was medication taken?"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="Schedule"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".effectiveTime"/> </mapping> <mapping> <identity value="v2"/> <map value="RAS:TQ1"/> </mapping> </definition> </element> <element> <path value="MedicationStatement.dosage.asNeeded[x]"/> <definition> <short value="Take "as needed" f(or x)"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="MedicationAsNeededReason"/> <isExtensible value="true"/> <conformance value="preferred"/> <description value="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."/> </binding> <mapping> <identity value="rim"/> <map value="boolean: .outboundRelationship[typeCode=PRCN].negationInd (inversed - so negationInd = true means asNeeded=false CodeableConcept: .outboundRelationship[typCode=PRCN].target[classCode=OBS , moodCode=EVN, isCriterionInd=true, code="Assertion"].value"/> </mapping> </definition> </element> <element> <path value="MedicationStatement.dosage.site"/> <definition> <short value="Where on body was medication administered?"/> <formal value="A coded specification of the anatomic site where the medication first enters the body."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="MedicationAdministrationSite"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/approach-site-codes"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".approachSiteCode"/> </mapping> <mapping> <identity value="v2"/> <map value="RXR-2-Administration Site"/> </mapping> </definition> </element> <element> <path value="MedicationStatement.dosage.route"/> <definition> <short value="How did the medication enter the body?"/> <formal value="A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="RouteOfAdministration"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/route-codes"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".routeCode"/> </mapping> <mapping> <identity value="v2"/> <map value="RXR-1-Route"/> </mapping> </definition> </element> <element> <path value="MedicationStatement.dosage.method"/> <definition> <short value="Technique used to administer medication"/> <formal value="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. Terminologies used often pre-coordinate this term with the route and or form of administration."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="MedicationAdministrationMethod"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/administration-method-codes"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".methodCode"/> </mapping> <mapping> <identity value="v2"/> <map value="RXR-4-Administration Method"/> </mapping> </definition> </element> <element> <path value="MedicationStatement.dosage.quantity"/> <definition> <short value="Amount administered in one dose"/> <formal value="The amount of therapeutic or other substance given at one administration event."/> <min value="0"/> <max value="1"/> <type> <code value="Quantity"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".doseQuantity"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-6-Administered Amount / RXA-7.1-Administered Units.code / RXA-7.3-Administered Units.name of coding system"/> </mapping> </definition> </element> <element> <path value="MedicationStatement.dosage.rate"/> <definition> <short value="Dose quantity per unit of time"/> <formal value="Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours."/> <min value="0"/> <max value="1"/> <type> <code value="Ratio"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".rateQuantity"/> </mapping> <mapping> <identity value="v2"/> <map value="RXA-12-Administered Per (Time Unit)"/> </mapping> </definition> </element> <element> <path value="MedicationStatement.dosage.maxDosePerPeriod"/> <definition> <short value="Maximum dose that was consumed per unit of time"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="Ratio"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".maxDoseQuantity"/> </mapping> <mapping> <identity value="v2"/> <map value="RXE-4-Give Amount - Maximum / RXE-5-Give Units"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="device"/> <type value="reference"/> <documentation value="Return administrations with this administration device identity"/> <xpath value="f:MedicationStatement/f:device"/> </searchParam> <searchParam> <name value="identifier"/> <type value="token"/> <documentation value="Return administrations with this external identity"/> <xpath value="f:MedicationStatement/f:identifier"/> </searchParam> <searchParam> <name value="medication"/> <type value="reference"/> <documentation value="Code for medicine or text in medicine name"/> <xpath value="f:MedicationStatement/f:medication"/> </searchParam> <searchParam> <name value="patient"/> <type value="reference"/> <documentation value="The identity of a patient to list administrations for"/> <xpath value="f:MedicationStatement/f:patient"/> </searchParam> <searchParam> <name value="when-given"/> <type value="date"/> <documentation value="Date of administration"/> <xpath value="f:MedicationStatement/f:whenGiven"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="medicationstatement-definitions.html#MedicationStatement" 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."><b>MedicationStatement</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="medicationstatement-definitions.html#MedicationStatement.identifier" 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)"><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> <<a class="dict" href="medicationstatement-definitions.html#MedicationStatement.patient" title="The person or animal who is /was taking the medication."><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> <<a class="dict" href="medicationstatement-definitions.html#MedicationStatement.wasNotGiven" title="Set this to true if the record is saying that the medication was NOT taken."><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> <<a class="dict" href="medicationstatement-definitions.html#MedicationStatement.reasonNotGiven" title="A code indicating why the medication was not taken."><b>reasonNotGiven</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: Reason not given is only permitted if wasNotGiven is true"><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 href="valueset-reason-medication-not-given-codes.html" style="color: navy">True if asserting medication was not given</a></span><span style="color: Gray"> --></span></reasonNotGiven> <<a class="dict" href="medicationstatement-definitions.html#MedicationStatement.whenGiven" title="The interval of time during which it is being asserted that the patient was taking the medication."><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> <<a class="dict" href="medicationstatement-definitions.html#MedicationStatement.medication" 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."><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> <<a class="dict" href="medicationstatement-definitions.html#MedicationStatement.device" title="An identifier or a link to a resource that identifies a device used in administering the medication to the patient."><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> <<a class="dict" href="medicationstatement-definitions.html#MedicationStatement.dosage" title="Indicates how the medication is/was used by the patient."><b>dosage</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Details of how medication was taken --></span> <<a class="dict" href="medicationstatement-definitions.html#MedicationStatement.dosage.timing" 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"."><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> <<a class="dict" href="medicationstatement-definitions.html#MedicationStatement.dosage.asNeeded_x_" 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."><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]> <<a class="dict" href="medicationstatement-definitions.html#MedicationStatement.dosage.site" title="A coded specification of the anatomic site where the medication first enters the body."><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 href="valueset-approach-site-codes.html" style="color: navy">Where on body was medication administered?</a></span><span style="color: Gray"> --></span></site> <<a class="dict" href="medicationstatement-definitions.html#MedicationStatement.dosage.route" title="A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject."><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 href="valueset-route-codes.html" style="color: navy">How did the medication enter the body?</a></span><span style="color: Gray"> --></span></route> <<a class="dict" href="medicationstatement-definitions.html#MedicationStatement.dosage.method" 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. Terminologies used often pre-coordinate this term with the route and or form of administration."><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 href="valueset-administration-method-codes.html" style="color: navy">Technique used to administer medication</a></span><span style="color: Gray"> --></span></method> <<a class="dict" href="medicationstatement-definitions.html#MedicationStatement.dosage.quantity" title="The amount of therapeutic or other substance given at one administration event."><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> <<a class="dict" href="medicationstatement-definitions.html#MedicationStatement.dosage.rate" title="Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours."><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> <<a class="dict" href="medicationstatement-definitions.html#MedicationStatement.dosage.maxDosePerPeriod" 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."><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"> Maximum dose that was consumed per unit of time</span><span style="color: Gray"> --></span></maxDosePerPeriod> </dosage> </MedicationStatement> </pre></div> </summary> </entry> <entry> <title>"messageheader" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/messageheader</id> <link href="http://hl7.org/implement/standards/fhir/messageheader.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="messageheader-definitions.html#MessageHeader" 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."><b>MessageHeader</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="messageheader-definitions.html#MessageHeader.identifier" title="The identifier of this message."><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> <<a class="dict" href="messageheader-definitions.html#MessageHeader.timestamp" title="The time that the message was sent."><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> <<a class="dict" href="messageheader-definitions.html#MessageHeader.event" 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/mes sage-type" (this element modifies the meaning of other elements)"><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 href="message-events.html" style="color: navy">Code for the event this message represents</a></span><span style="color: Gray"> --></span></event> <<a class="dict" href="messageheader-definitions.html#MessageHeader.response" 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)"><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> <<a class="dict" href="messageheader-definitions.html#MessageHeader.response.identifier" title="The id of the message that this message is a response to."><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> <<a class="dict" href="messageheader-definitions.html#MessageHeader.response.code" 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)"><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 href="response-code.html" style="color: navy">ok | transient-error | fatal-error</a></span><span style="color: Gray"> --></span> <<a class="dict" href="messageheader-definitions.html#MessageHeader.response.details" title="Full details of any issues found in the message."><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> </response> <<a class="dict" href="messageheader-definitions.html#MessageHeader.source" title="The source application from which this message originated."><b>source</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>1..1</b></span> Message Source Application --></span> <<a class="dict" href="messageheader-definitions.html#MessageHeader.source.name" title="Human-readable name for the target system."><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> <<a class="dict" href="messageheader-definitions.html#MessageHeader.source.software" title="May include configuration or other information useful in debugging."><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> <<a class="dict" href="messageheader-definitions.html#MessageHeader.source.version" title="Can convey versions of multiple systems in situations where a message passes through multiple hands."><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> <<a class="dict" href="messageheader-definitions.html#MessageHeader.source.contact" title="An e-mail, phone, website or other contact point to use to resolve issues with message communications."><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> <<a class="dict" href="messageheader-definitions.html#MessageHeader.source.endpoint" title="Identifies the routing target to send acknowledgements to."><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> </source> <<a class="dict" href="messageheader-definitions.html#MessageHeader.destination" title="The destination application which the message is intended for."><b>destination</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Message Destination Application(s) --></span> <<a class="dict" href="messageheader-definitions.html#MessageHeader.destination.name" title="Human-readable name for the source system."><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> <<a class="dict" href="messageheader-definitions.html#MessageHeader.destination.target" title="Identifies the target end system in situations where the initial message transmission is to an intermediary system."><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> <<a class="dict" href="messageheader-definitions.html#MessageHeader.destination.endpoint" title="Indicates where the message should be routed to."><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> </destination> <<a class="dict" href="messageheader-definitions.html#MessageHeader.enterer" 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."><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> <<a class="dict" href="messageheader-definitions.html#MessageHeader.author" 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."><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> <<a class="dict" href="messageheader-definitions.html#MessageHeader.receiver" 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."><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"> Intended "real-world" recipient for the data</span><span style="color: Gray"> --></span></receiver> <<a class="dict" href="messageheader-definitions.html#MessageHeader.responsible" 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."><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"> Final responsibility for event</span><span style="color: Gray"> --></span></responsible> <<a class="dict" href="messageheader-definitions.html#MessageHeader.reason" 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."><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 href="valueset-message-reason-encounter.html" style="color: navy">Cause of event</a></span><span style="color: Gray"> --></span></reason> <<a class="dict" href="messageheader-definitions.html#MessageHeader.data" title="The actual data of the message - a reference to the root/focus class of the event."><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> </MessageHeader> </pre></div> </text> <name value="messageheader"/> <publisher value="FHIR Project"/> <description value="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 value="draft"/> <date value="2014-09-30"/> <requirements value="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 value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <structure> <type value="MessageHeader"/> <publish value="true"/> <element> <path value="MessageHeader"/> <definition> <short value="A resource that describes a message that is exchanged between systems"/> <formal value="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 value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Message"/> </mapping> <mapping> <identity value="v2"/> <map value="MSH / MSA / ERR"/> </mapping> </definition> </element> <element> <path value="MessageHeader.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MessageHeader.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MessageHeader.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MessageHeader.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MessageHeader.identifier"/> <definition> <short value="Id of this message"/> <formal value="The identifier of this message."/> <comments value="This SHALL be unique within the scope of this stream of messages."/> <min value="1"/> <max value="1"/> <type> <code value="id"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Message.id"/> </mapping> <mapping> <identity value="v2"/> <map value="MSH-10-message control ID"/> </mapping> </definition> </element> <element> <path value="MessageHeader.timestamp"/> <definition> <short value="Time that the message was sent"/> <formal value="The time that the message was sent."/> <min value="1"/> <max value="1"/> <type> <code value="instant"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./creationTime[isNormalDatatype()]"/> </mapping> <mapping> <identity value="v2"/> <map value="MSH-7-message date/time"/> </mapping> </definition> </element> <element> <path value="MessageHeader.event"/> <definition> <short value="Code for the event this message represents"/> <formal value="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/mes sage-type"."/> <min value="1"/> <max value="1"/> <type> <code value="Coding"/> </type> <isModifier value="true"/> <binding> <name value="MessageEvent"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/message-events"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="./payload[classCode="CACT" and moodCode="EVN" and isNormalAct()]/code[isNormalDa tatype()]/code"/> </mapping> <mapping> <identity value="v2"/> <map value="MSH-9.2-message type.trigger event"/> </mapping> </definition> </element> <element> <path value="MessageHeader.response"/> <definition> <short value="If this is a reply to prior message"/> <formal value="Information about the message that this message is a response to. Only present if this message is a response."/> <min value="0"/> <max value="1"/> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="./conveyedAcknowledgement"/> </mapping> <mapping> <identity value="v2"/> <map value="MSA"/> </mapping> </definition> </element> <element> <path value="MessageHeader.response.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MessageHeader.response.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MessageHeader.response.identifier"/> <definition> <short value="Id of original message"/> <formal value="The id of the message that this message is a response to."/> <min value="1"/> <max value="1"/> <type> <code value="id"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./acknowledges.id[isNormalDatatype()]"/> </mapping> <mapping> <identity value="v2"/> <map value="MSA-2-message control ID"/> </mapping> </definition> </element> <element> <path value="MessageHeader.response.code"/> <definition> <short value="ok | transient-error | fatal-error"/> <formal value="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 value="This is a generic response to the request message. Specific data for the response will be found in MessageHeader.data."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="ResponseType"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/response-code"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="./typeCode[isNormalDatatype()]"/> </mapping> <mapping> <identity value="v2"/> <map value="MSA-1-acknowledgment code"/> </mapping> </definition> </element> <element> <path value="MessageHeader.response.details"/> <definition> <short value="Specific list of hints/warnings/errors"/> <formal value="Full details of any issues found in the message."/> <comments value="This SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/OperationOutcome"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="AcknowledgementDetail or Observation[classCode="ALRT" and moodCode="EVN"]"/> </mapping> <mapping> <identity value="v2"/> <map value="ERR"/> </mapping> </definition> </element> <element> <path value="MessageHeader.source"/> <definition> <short value="Message Source Application"/> <formal value="The source application from which this message originated."/> <min value="1"/> <max value="1"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="unique(./communicationFunction[typeCode="SND"])"/> </mapping> </definition> </element> <element> <path value="MessageHeader.source.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MessageHeader.source.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MessageHeader.source.name"/> <definition> <short value="Name of system"/> <formal value="Human-readable name for the target system."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="unique(./entity[determinerCode="INST" and classCode="DEV"]/name[type='ST' and isNormalDatatype()])"/> </mapping> <mapping> <identity value="v2"/> <map value="MSH-3-sending application"/> </mapping> </definition> </element> <element> <path value="MessageHeader.source.software"/> <definition> <short value="Name of software running the system"/> <formal value="May include configuration or other information useful in debugging."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="unique(./entity[determinerCode="INST" and classCode="DEV"]/softwareName[isNormal Datatype()])"/> </mapping> <mapping> <identity value="v2"/> <map value="SFT-3-software product name ( +SFT-1-software vendor organization)"/> </mapping> </definition> </element> <element> <path value="MessageHeader.source.version"/> <definition> <short value="Version of software running"/> <formal value="Can convey versions of multiple systems in situations where a message passes through multiple hands."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="(Not supported)"/> </mapping> <mapping> <identity value="v2"/> <map value="SFT-2-software certified version or release number"/> </mapping> </definition> </element> <element> <path value="MessageHeader.source.contact"/> <definition> <short value="Human contact for problems"/> <formal value="An e-mail, phone, website or other contact point to use to resolve issues with message communications."/> <min value="0"/> <max value="1"/> <type> <code value="Contact"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="unique(./entity[determinerCode="INST" and classCode="DEV"]/scopesRole[normalRole () and classCode="CON" and layer[classCode="PSN"]/telecom[isNormalDatatype()])"/> </mapping> <mapping> <identity value="v2"/> <map value="(MSH-22?)"/> </mapping> </definition> </element> <element> <path value="MessageHeader.source.endpoint"/> <definition> <short value="Actual message source address or id"/> <formal value="Identifies the routing target to send acknowledgements to."/> <comments value="The id may be a non-resolvable URI for systems that do not use standard network-based addresses."/> <min value="1"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./telecom[isNormalDatatype()]"/> </mapping> <mapping> <identity value="v2"/> <map value="MSH-24-sending network address"/> </mapping> </definition> </element> <element> <path value="MessageHeader.destination"/> <definition> <short value="Message Destination Application(s)"/> <formal value="The destination application which the message is intended for."/> <comments value="there SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./communicationFunction[typeCode="RCV"]"/> </mapping> </definition> </element> <element> <path value="MessageHeader.destination.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MessageHeader.destination.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MessageHeader.destination.name"/> <definition> <short value="Name of system"/> <formal value="Human-readable name for the source system."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="unique(./entity[determinerCode="INST" and (classCode=("DEV", "PSN", "ORG"]/name[type='ST' and isNormalDatatype()])"/> </mapping> <mapping> <identity value="v2"/> <map value="MSH-5-receiving application"/> </mapping> </definition> </element> <element> <path value="MessageHeader.destination.target"/> <definition> <short value="Particular delivery destination within the destination"/> <formal value="Identifies the target end system in situations where the initial message transmission is to an intermediary system."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Device"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="unique(./entity[determinerCode="INST" and (classCode=("DEV", "PSN", "ORG"]"/> </mapping> </definition> </element> <element> <path value="MessageHeader.destination.endpoint"/> <definition> <short value="Actual destination address or id"/> <formal value="Indicates where the message should be routed to."/> <comments value="The id may be a non-resolvable URI for systems that do not use standard network-based addresses."/> <min value="1"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./telecom"/> </mapping> <mapping> <identity value="v2"/> <map value="MSH-25-receiving network address (or MSH-6-receiving facility by implication)"/> </mapping> </definition> </element> <element> <path value="MessageHeader.enterer"/> <definition> <short value="The source of the data entry"/> <formal value="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 value="Usually only for the request, but can be used in a response."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/part icipation[typeCode="ENT" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()]/player[isNormalEntity() and classCode=("DEV", "PSN") and determinerCode="INST"])"/> </mapping> <mapping> <identity value="v2"/> <map value="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"/> </mapping> </definition> </element> <element> <path value="MessageHeader.author"/> <definition> <short value="The source of the decision"/> <formal value="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 value="Usually only for the request, but can be used in a response."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/part icipation[isHighest(priorityCode) and typeCode="AUT" and isNormalParticipation]/role[classC ode="ASSIGNED" and isNormalRole()]/player[isNormalEntity() and classCode=("DEV", "PSN") and determinerCode="INST"])"/> </mapping> <mapping> <identity value="v2"/> <map value="ORC-19-action by / PRT-5-Participation Person:PRT-4-Participation='AUT' / ROL where ROL.3 is IP or ORC.12"/> </mapping> </definition> </element> <element> <path value="MessageHeader.receiver"/> <definition> <short value="Intended "real-world" recipient for the data"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Organization"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText"/> </mapping> <mapping> <identity value="v2"/> <map value="PRT-5-Participation Person:PRT-4-Participation='WAYR' / PRT-8-Participation Organization:PRT-4-Parti cipation='WAYR'"/> </mapping> </definition> </element> <element> <path value="MessageHeader.responsible"/> <definition> <short value="Final responsibility for event"/> <formal value="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 value="Usually only for the request, but can be used in a response."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Organization"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/part icipation[isHighest(priorityCode) and typeCode="RESP" and isNormalParticipation]/role[class Code="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[isNormalEn tity() and classCode="ORG" and determinerCode="INST"])"/> </mapping> <mapping> <identity value="v2"/> <map value="ORC-12-ordering provider / PRT-5-Participation Person:PRT-4-Participation='OP' / PRT-8-Participati on Organization:PRT-4-Participation='OP' / ROL where ROL.3 is RO or ORC.11"/> </mapping> </definition> </element> <element> <path value="MessageHeader.reason"/> <definition> <short value="Cause of event"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="EventReason"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/message-reason-encounter"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/reas onCode[isNormalDatatype()])"/> </mapping> <mapping> <identity value="v2"/> <map value="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"/> </mapping> </definition> </element> <element> <path value="MessageHeader.data"/> <definition> <short value="The actual content of the message"/> <formal value="The actual data of the message - a reference to the root/focus class of the event."/> <comments value="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 value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Any"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/part icipation[typeCode="SUBJ" and isNormalParticipation]/role or ./controlAct[classCode="C ACT" and classCode="EVN" and isNormalAct()]/outboundRelationship[typeCode="SBJ&qu ot; and isNormalActRelatoinship]/target)"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="messageheader-definitions.html#MessageHeader" 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."><b>MessageHeader</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="messageheader-definitions.html#MessageHeader.identifier" title="The identifier of this message."><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> <<a class="dict" href="messageheader-definitions.html#MessageHeader.timestamp" title="The time that the message was sent."><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> <<a class="dict" href="messageheader-definitions.html#MessageHeader.event" 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/mes sage-type" (this element modifies the meaning of other elements)"><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 href="message-events.html" style="color: navy">Code for the event this message represents</a></span><span style="color: Gray"> --></span></event> <<a class="dict" href="messageheader-definitions.html#MessageHeader.response" 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)"><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> <<a class="dict" href="messageheader-definitions.html#MessageHeader.response.identifier" title="The id of the message that this message is a response to."><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> <<a class="dict" href="messageheader-definitions.html#MessageHeader.response.code" 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)"><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 href="response-code.html" style="color: navy">ok | transient-error | fatal-error</a></span><span style="color: Gray"> --></span> <<a class="dict" href="messageheader-definitions.html#MessageHeader.response.details" title="Full details of any issues found in the message."><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> </response> <<a class="dict" href="messageheader-definitions.html#MessageHeader.source" title="The source application from which this message originated."><b>source</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>1..1</b></span> Message Source Application --></span> <<a class="dict" href="messageheader-definitions.html#MessageHeader.source.name" title="Human-readable name for the target system."><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> <<a class="dict" href="messageheader-definitions.html#MessageHeader.source.software" title="May include configuration or other information useful in debugging."><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> <<a class="dict" href="messageheader-definitions.html#MessageHeader.source.version" title="Can convey versions of multiple systems in situations where a message passes through multiple hands."><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> <<a class="dict" href="messageheader-definitions.html#MessageHeader.source.contact" title="An e-mail, phone, website or other contact point to use to resolve issues with message communications."><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> <<a class="dict" href="messageheader-definitions.html#MessageHeader.source.endpoint" title="Identifies the routing target to send acknowledgements to."><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> </source> <<a class="dict" href="messageheader-definitions.html#MessageHeader.destination" title="The destination application which the message is intended for."><b>destination</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Message Destination Application(s) --></span> <<a class="dict" href="messageheader-definitions.html#MessageHeader.destination.name" title="Human-readable name for the source system."><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> <<a class="dict" href="messageheader-definitions.html#MessageHeader.destination.target" title="Identifies the target end system in situations where the initial message transmission is to an intermediary system."><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> <<a class="dict" href="messageheader-definitions.html#MessageHeader.destination.endpoint" title="Indicates where the message should be routed to."><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> </destination> <<a class="dict" href="messageheader-definitions.html#MessageHeader.enterer" 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."><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> <<a class="dict" href="messageheader-definitions.html#MessageHeader.author" 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."><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> <<a class="dict" href="messageheader-definitions.html#MessageHeader.receiver" 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."><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"> Intended "real-world" recipient for the data</span><span style="color: Gray"> --></span></receiver> <<a class="dict" href="messageheader-definitions.html#MessageHeader.responsible" 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."><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"> Final responsibility for event</span><span style="color: Gray"> --></span></responsible> <<a class="dict" href="messageheader-definitions.html#MessageHeader.reason" 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."><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 href="valueset-message-reason-encounter.html" style="color: navy">Cause of event</a></span><span style="color: Gray"> --></span></reason> <<a class="dict" href="messageheader-definitions.html#MessageHeader.data" title="The actual data of the message - a reference to the root/focus class of the event."><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> </MessageHeader> </pre></div> </summary> </entry> <entry> <title>"observation" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/observation</id> <link href="http://hl7.org/implement/standards/fhir/observation.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="observation-definitions.html#Observation" title="Measurements and simple assertions made about a patient, device or other subject."><b>Observation</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="observation-definitions.html#Observation.name" title="Describes what was observed. Sometimes this is called the observation "code"."><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 href="valueset-observation-codes.html" style="color: navy">Type of observation (code / type)</a></span><span style="color: Gray"> --></span></name> <<a class="dict" href="observation-definitions.html#Observation.value_x_" title="The information determined as a result of making the observation, if the information has a simple value."><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>| <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]> <<a class="dict" href="observation-definitions.html#Observation.interpretation" title="The assessment made based on the result of the observation."><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 href="valueset-observation-interpretation.html" style="color: navy">High, low, normal, etc.</a></span><span style="color: Gray"> --></span></interpretation> <<a class="dict" href="observation-definitions.html#Observation.comments" 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."><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> <<a class="dict" href="observation-definitions.html#Observation.applies_x_" 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."><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"> Physiologically Relevant time/time-period for observation</span><span style="color: Gray"> --></span></applies[x]> <<a class="dict" href="observation-definitions.html#Observation.issued" title="Date/Time this was made available."><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> <<a class="dict" href="observation-definitions.html#Observation.status" title="The status of the result value (this element modifies the meaning of other elements)"><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 href="observation-status.html" style="color: navy">registered | preliminary | final | amended +</a></span><span style="color: Gray"> --></span> <<a class="dict" href="observation-definitions.html#Observation.reliability" title="An estimate of the degree to which quality issues have impacted on the value reported (this element modifies the meaning of other elements)"><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 href="observation-reliability.html" style="color: navy">ok | ongoing | early | questionable | calibrating | error +</a></span><span style="color: Gray"> --></span> <<a class="dict" href="observation-definitions.html#Observation.bodySite" title="Indicates where on the subject's body the observation was made."><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 href="valueset-body-site.html" style="color: navy">Observed body part</a></span><span style="color: Gray"> --></span></bodySite> <<a class="dict" href="observation-definitions.html#Observation.method" title="Indicates the mechanism used to perform the observation."><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 href="valueset-observation-methods.html" style="color: navy">How it was done</a></span><span style="color: Gray"> --></span></method> <<a class="dict" href="observation-definitions.html#Observation.identifier" title="A unique identifier for the simple observation."><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> <<a class="dict" href="observation-definitions.html#Observation.subject" title="The thing the observation is being made about."><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> <<a class="dict" href="observation-definitions.html#Observation.specimen" title="The specimen that was used when this observation was made."><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> <<a class="dict" href="observation-definitions.html#Observation.performer" title="Who was responsible for asserting the observed value as "true"."><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> <<a class="dict" href="observation-definitions.html#Observation.referenceRange" title="Guidance on how to interpret the value by comparison to a normal or recommended range."><b>referenceRange</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Provides guide for interpretation --></span> <<a class="dict" href="observation-definitions.html#Observation.referenceRange.low" 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."><b>low</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-3: Must have at least a low or a high (and no comparators)"><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> <<a class="dict" href="observation-definitions.html#Observation.referenceRange.high" 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."><b>high</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-3: Must have at least a low or a high (and no comparators)"><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> <<a class="dict" href="observation-definitions.html#Observation.referenceRange.meaning" title="Code for the meaning of the reference range."><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 href="valueset-referencerange-meaning.html" style="color: navy">Indicates the meaning/use of this range of this range</a></span><span style="color: Gray"> --></span></meaning> <<a class="dict" href="observation-definitions.html#Observation.referenceRange.age" 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."><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> </referenceRange> <<a class="dict" href="observation-definitions.html#Observation.related" title="Related observations - either components, or previous observations, or statements of derivation."><b>related</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Observations related to this observation --></span> <<a class="dict" href="observation-definitions.html#Observation.related.type" title="A code specifying the kind of relationship that exists with the target observation."><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 href="observation-relationshiptypes.html" style="color: navy">has-component | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by</a></span><span style="color: Gray"> --></span> <<a class="dict" href="observation-definitions.html#Observation.related.target" title="A reference to the observation that is related to this observation."><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> </related> </Observation> </pre></div> </text> <name value="observation"/> <publisher value="FHIR Project"/> <description value="Basic Profile. Measurements and simple assertions made about a patient, device or other subject."/> <status value="draft"/> <date value="2014-09-30"/> <requirements value="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: * Vital signs: temperature, blood pressure, respiration rate * Laboratory Data and other Diagnostic Measures * Measurements emitted by Devices * Clinical assessments such as APGAR * Personal characteristics: height, weight, eye-color * Diagnoses (Note: trackable conditions, allergies, adverse reactions and more complex structures are handled elsewhere) * Social history: tobacco use, family supports, cognitive status * Core characteristics: pregnancy status, death assertion"/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <structure> <type value="Observation"/> <publish value="true"/> <element> <path value="Observation"/> <definition> <short value="Measurements and simple assertions"/> <formal value="Measurements and simple assertions made about a patient, device or other subject."/> <comments value="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 value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <constraint> <key value="2"/> <name value="reference range for quantity"/> <severity value="error"/> <human value="Can only have normal range if value is a quantity"/> <xpath value="exists(f:valueQuantity) or not(exists(f:normalRange))"/> </constraint> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Observation[classCode=OBS, moodCode=EVN]"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX"/> </mapping> </definition> </element> <element> <path value="Observation.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Observation.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Observation.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Observation.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Observation.name"/> <definition> <short value="Type of observation (code / type)"/> <formal value="Describes what was observed. Sometimes this is called the observation "code"."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="ObservationType"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/observation-codes"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="code"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-3-observation identifier"/> </mapping> </definition> </element> <element> <path value="Observation.value[x]"/> <definition> <short value="Actual result"/> <formal value="The information determined as a result of making the observation, if the information has a simple value."/> <comments value="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.val ue[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 value="0"/> <max value="1"/> <type> <code value="Quantity"/> </type> <type> <code value="CodeableConcept"/> </type> <type> <code value="Attachment"/> </type> <type> <code value="Ratio"/> </type> <type> <code value="Period"/> </type> <type> <code value="SampledData"/> </type> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="value"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX.2, OBX.5, OBX.6"/> </mapping> </definition> </element> <element> <path value="Observation.interpretation"/> <definition> <short value="High, low, normal, etc."/> <formal value="The assessment made based on the result of the observation."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="ObservationInterpretation"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/observation-interpretation"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="interpretationCode"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-8-interpretation codes"/> </mapping> </definition> </element> <element> <path value="Observation.comments"/> <definition> <short value="Comments about result"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="subjectOf.observationEvent[code="annotation"].value"/> </mapping> <mapping> <identity value="v2"/> <map value="NTE.3 (partner NTE to OBX, or sometimes another (child?) OBX)"/> </mapping> </definition> </element> <element> <path value="Observation.applies[x]"/> <definition> <short value="Physiologically Relevant time/time-period for observation"/> <formal value="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 value="At least a date should be present unless this observation is a historical report."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <type> <code value="Period"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="effectiveTime"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-14-date/time of the observation, and/or OBX-19 after v2.4 (depends on who observation made)"/> </mapping> </definition> </element> <element> <path value="Observation.issued"/> <definition> <short value="Date/Time this was made available"/> <formal value="Date/Time this was made available."/> <comments value="Updated when the result is updated."/> <min value="0"/> <max value="1"/> <type> <code value="instant"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="participation[typeCode=AUT].time"/> </mapping> <mapping> <identity value="v2"/> <map value="OBR.22 (or MSH.7), or perhaps OBX-19 (depends on who observation made)"/> </mapping> </definition> </element> <element> <path value="Observation.status"/> <definition> <short value="registered | preliminary | final | amended +"/> <formal value="The status of the result value."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="ObservationStatus"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/observation-status"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="status Amended & Final are differentiated by whether it is the subject of a ControlAct event with a type of "revise""/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-11-observation result status"/> </mapping> </definition> </element> <element> <path value="Observation.reliability"/> <definition> <short value="ok | ongoing | early | questionable | calibrating | error +"/> <formal value="An estimate of the degree to which quality issues have impacted on the value reported."/> <comments value="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 value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="ObservationReliability"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/observation-reliability"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="uncertaintyCode"/> </mapping> <mapping> <identity value="v2"/> <map value="Maybe OBX.8/OBX.9"/> </mapping> </definition> </element> <element> <path value="Observation.bodySite"/> <definition> <short value="Observed body part"/> <formal value="Indicates where on the subject's body the observation was made."/> <comments value="Only used if not implicit in code found in Observation.name."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="BodySite"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/body-site"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="targetSiteCode"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-20-observation site"/> </mapping> </definition> </element> <element> <path value="Observation.method"/> <definition> <short value="How it was done"/> <formal value="Indicates the mechanism used to perform the observation."/> <comments value="Only used if not implicit in code for Observation.name."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="ObservationMethod"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/observation-methods"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="methodCode"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-17-observation method"/> </mapping> </definition> </element> <element> <path value="Observation.identifier"/> <definition> <short value="Unique Id for this particular observation"/> <formal value="A unique identifier for the simple observation."/> <min value="0"/> <max value="1"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="id"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX.21"/> </mapping> </definition> </element> <element> <path value="Observation.subject"/> <definition> <short value="Who and/or what this is about"/> <formal value="The thing the observation is being made about."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Group"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Device"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Location"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="participation[typeCode=SBJ]"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-3-patient ID list"/> </mapping> </definition> </element> <element> <path value="Observation.specimen"/> <definition> <short value="Specimen used for this observation"/> <formal value="The specimen that was used when this observation was made."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Specimen"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="participation[typeCode=SPC].specimen"/> </mapping> </definition> </element> <element> <path value="Observation.performer"/> <definition> <short value="Who did the observation"/> <formal value="Who was responsible for asserting the observed value as "true"."/> <comments value="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 value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Device"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Organization"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="participation[typeCode=PRF]"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX.15 / (Practitioner) OBX-16-responsible observer, PRT-5-participation person:PRT-4-participatio n='RO' / (Device) OBX-18-equipment instance identifier , PRT-10-participation device:PRT-4-particip ation='EQUIP' / (Organization) OBX-23-performing organization name, PRT-8-participation organization:PRT-4-participation='PO'"/> </mapping> </definition> </element> <element> <path value="Observation.referenceRange"/> <definition> <short value="Provides guide for interpretation"/> <formal value="Guidance on how to interpret the value by comparison to a normal or recommended range."/> <comments value="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 value="0"/> <max value="*"/> <constraint> <key value="3"/> <name value="reference range"/> <severity value="error"/> <human value="Must have at least a low or a high (and no comparators)"/> <xpath value="(exists(f:low) or exists(f:high)) and not(exists(f:low/f:comparator)) and not(exists(f:high/f:compar ator))"/> </constraint> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]"/> </mapping> </definition> </element> <element> <path value="Observation.referenceRange.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Observation.referenceRange.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Observation.referenceRange.low"/> <definition> <short value="Low Range, if relevant"/> <formal value="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 value="Do not use the comparator for < or >."/> <min value="0"/> <max value="1"/> <type> <code value="Quantity"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="value:IVL_PQ.low"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-7-references range"/> </mapping> </definition> </element> <element> <path value="Observation.referenceRange.high"/> <definition> <short value="High Range, if relevant"/> <formal value="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 value="Do not use the comparator for < or >."/> <min value="0"/> <max value="1"/> <type> <code value="Quantity"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="value:IVL_PQ.high"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-7-references range"/> </mapping> </definition> </element> <element> <path value="Observation.referenceRange.meaning"/> <definition> <short value="Indicates the meaning/use of this range of this range"/> <formal value="Code for the meaning of the reference range."/> <comments value="This SHOULD be populated if there is more than one range."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="ObservationRangeMeaning"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/referencerange-meaning"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="interpretationCode"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-10-nature of abnormal test?"/> </mapping> </definition> </element> <element> <path value="Observation.referenceRange.age"/> <definition> <short value="Applicable age range, if relevant"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="Range"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="outboundRelationship[typeCode=PRCN].targetObservationCriterion[code="age"].value"/> </mapping> </definition> </element> <element> <path value="Observation.related"/> <definition> <short value="Observations related to this observation"/> <formal value="Related observations - either components, or previous observations, or statements of derivation."/> <comments value="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 value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="outBoundRelationship"/> </mapping> <mapping> <identity value="v2"/> <map value="Relationships established by OBX-4 usage"/> </mapping> </definition> </element> <element> <path value="Observation.related.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Observation.related.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Observation.related.type"/> <definition> <short value="has-component | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by"/> <formal value="A code specifying the kind of relationship that exists with the target observation."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="ObservationRelationshipType"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/observation-relationshiptypes"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".typeCode"/> </mapping> <mapping> <identity value="v2"/> <map value="N/A"/> </mapping> </definition> </element> <element> <path value="Observation.related.target"/> <definition> <short value="Observation that is related to this one"/> <formal value="A reference to the observation that is related to this observation."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Observation"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".targetObservation"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="date"/> <type value="date"/> <documentation value="Obtained date/time. If the obtained element is a period, a date that falls in the period"/> <xpath value="f:Observation/f:applies[x]"/> </searchParam> <searchParam> <name value="name"/> <type value="token"/> <documentation value="The name of the observation type"/> <xpath value="f:Observation/f:name"/> </searchParam> <searchParam> <name value="name-value-[x]"/> <type value="composite"/> <documentation value="Both name and one of the value parameters"/> </searchParam> <searchParam> <name value="performer"/> <type value="reference"/> <documentation value="Who and/or what performed the observation"/> <xpath value="f:Observation/f:performer"/> </searchParam> <searchParam> <name value="related"/> <type value="composite"/> <documentation value="Related Observations - search on related-type and related-target together"/> </searchParam> <searchParam> <name value="related-target"/> <type value="reference"/> <documentation value="Observation that is related to this one"/> <xpath value="f:Observation/f:related/f:target"/> </searchParam> <searchParam> <name value="related-type"/> <type value="token"/> <documentation value="has-component | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by"/> <xpath value="f:Observation/f:related/f:type"/> </searchParam> <searchParam> <name value="reliability"/> <type value="token"/> <documentation value="The reliability of the observation"/> <xpath value="f:Observation/f:reliability"/> </searchParam> <searchParam> <name value="specimen"/> <type value="reference"/> <documentation value="Specimen used for this observation"/> <xpath value="f:Observation/f:specimen"/> </searchParam> <searchParam> <name value="status"/> <type value="token"/> <documentation value="The status of the observation"/> <xpath value="f:Observation/f:status"/> </searchParam> <searchParam> <name value="subject"/> <type value="reference"/> <documentation value="The subject that the observation is about"/> <xpath value="f:Observation/f:subject"/> </searchParam> <searchParam> <name value="value-concept"/> <type value="token"/> <documentation value="The value of the observation, if the value is a CodeableConcept"/> <xpath value="f:Observation/f:value[x]"/> </searchParam> <searchParam> <name value="value-date"/> <type value="date"/> <documentation value="The value of the observation, if the value is a Period"/> <xpath value="f:Observation/f:value[x]"/> </searchParam> <searchParam> <name value="value-quantity"/> <type value="quantity"/> <documentation value="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 value="f:Observation/f:value[x]"/> </searchParam> <searchParam> <name value="value-string"/> <type value="string"/> <documentation value="The value of the observation, if the value is a string, and also searches in CodeableConcept.text"/> <xpath value="f:Observation/f:value[x]"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="observation-definitions.html#Observation" title="Measurements and simple assertions made about a patient, device or other subject."><b>Observation</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="observation-definitions.html#Observation.name" title="Describes what was observed. Sometimes this is called the observation "code"."><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 href="valueset-observation-codes.html" style="color: navy">Type of observation (code / type)</a></span><span style="color: Gray"> --></span></name> <<a class="dict" href="observation-definitions.html#Observation.value_x_" title="The information determined as a result of making the observation, if the information has a simple value."><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>| <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]> <<a class="dict" href="observation-definitions.html#Observation.interpretation" title="The assessment made based on the result of the observation."><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 href="valueset-observation-interpretation.html" style="color: navy">High, low, normal, etc.</a></span><span style="color: Gray"> --></span></interpretation> <<a class="dict" href="observation-definitions.html#Observation.comments" 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."><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> <<a class="dict" href="observation-definitions.html#Observation.applies_x_" 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."><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"> Physiologically Relevant time/time-period for observation</span><span style="color: Gray"> --></span></applies[x]> <<a class="dict" href="observation-definitions.html#Observation.issued" title="Date/Time this was made available."><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> <<a class="dict" href="observation-definitions.html#Observation.status" title="The status of the result value (this element modifies the meaning of other elements)"><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 href="observation-status.html" style="color: navy">registered | preliminary | final | amended +</a></span><span style="color: Gray"> --></span> <<a class="dict" href="observation-definitions.html#Observation.reliability" title="An estimate of the degree to which quality issues have impacted on the value reported (this element modifies the meaning of other elements)"><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 href="observation-reliability.html" style="color: navy">ok | ongoing | early | questionable | calibrating | error +</a></span><span style="color: Gray"> --></span> <<a class="dict" href="observation-definitions.html#Observation.bodySite" title="Indicates where on the subject's body the observation was made."><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 href="valueset-body-site.html" style="color: navy">Observed body part</a></span><span style="color: Gray"> --></span></bodySite> <<a class="dict" href="observation-definitions.html#Observation.method" title="Indicates the mechanism used to perform the observation."><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 href="valueset-observation-methods.html" style="color: navy">How it was done</a></span><span style="color: Gray"> --></span></method> <<a class="dict" href="observation-definitions.html#Observation.identifier" title="A unique identifier for the simple observation."><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> <<a class="dict" href="observation-definitions.html#Observation.subject" title="The thing the observation is being made about."><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> <<a class="dict" href="observation-definitions.html#Observation.specimen" title="The specimen that was used when this observation was made."><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> <<a class="dict" href="observation-definitions.html#Observation.performer" title="Who was responsible for asserting the observed value as "true"."><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> <<a class="dict" href="observation-definitions.html#Observation.referenceRange" title="Guidance on how to interpret the value by comparison to a normal or recommended range."><b>referenceRange</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Provides guide for interpretation --></span> <<a class="dict" href="observation-definitions.html#Observation.referenceRange.low" 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."><b>low</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-3: Must have at least a low or a high (and no comparators)"><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> <<a class="dict" href="observation-definitions.html#Observation.referenceRange.high" 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."><b>high</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-3: Must have at least a low or a high (and no comparators)"><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> <<a class="dict" href="observation-definitions.html#Observation.referenceRange.meaning" title="Code for the meaning of the reference range."><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 href="valueset-referencerange-meaning.html" style="color: navy">Indicates the meaning/use of this range of this range</a></span><span style="color: Gray"> --></span></meaning> <<a class="dict" href="observation-definitions.html#Observation.referenceRange.age" 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."><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> </referenceRange> <<a class="dict" href="observation-definitions.html#Observation.related" title="Related observations - either components, or previous observations, or statements of derivation."><b>related</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Observations related to this observation --></span> <<a class="dict" href="observation-definitions.html#Observation.related.type" title="A code specifying the kind of relationship that exists with the target observation."><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 href="observation-relationshiptypes.html" style="color: navy">has-component | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by</a></span><span style="color: Gray"> --></span> <<a class="dict" href="observation-definitions.html#Observation.related.target" title="A reference to the observation that is related to this observation."><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> </related> </Observation> </pre></div> </summary> </entry> <entry> <title>"operationoutcome" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/operationoutcome</id> <link href="http://hl7.org/implement/standards/fhir/operationoutcome.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="operationoutcome-definitions.html#OperationOutcome" title="A collection of error, warning or information messages that result from a system action."><b>OperationOutcome</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="operationoutcome-definitions.html#OperationOutcome.issue" title="An error, warning or information message that results from a system action."><b>issue</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>1..*</b></span> A single issue associated with the action --></span> <<a class="dict" href="operationoutcome-definitions.html#OperationOutcome.issue.severity" title="Indicates whether the issue indicates a variation from successful processing (this element modifies the meaning of other elements)"><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 href="issue-severity.html" style="color: navy">fatal | error | warning | information</a></span><span style="color: Gray"> --></span> <<a class="dict" href="operationoutcome-definitions.html#OperationOutcome.issue.type" title="A code indicating the type of error, warning or information message."><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 href="issue-type.html" style="color: navy">Error or warning code</a></span><span style="color: Gray"> --></span></type> <<a class="dict" href="operationoutcome-definitions.html#OperationOutcome.issue.details" title="Additional description of the issue."><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> <<a class="dict" href="operationoutcome-definitions.html#OperationOutcome.issue.location" 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."><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> </issue> </OperationOutcome> </pre></div> </text> <name value="operationoutcome"/> <publisher value="FHIR Project"/> <description value="Basic Profile. A collection of error, warning or information messages that result from a system action."/> <status value="draft"/> <date value="2014-09-30"/> <requirements value="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. Specifically, OperationOutcomes are used in the following circumstances: * When an RESTful operation fails * As the response on a validation operation, to provide information about the outcomes * As part of a message response, usually when the message has not been processed correctly"/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <structure> <type value="OperationOutcome"/> <publish value="true"/> <element> <path value="OperationOutcome"/> <definition> <short value="Information about the success/failure of an action"/> <formal value="A collection of error, warning or information messages that result from a system action."/> <comments value="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 value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Grouping is handled through multiple repetitions from whatever context references the outcomes (no specific grouper required)"/> </mapping> </definition> </element> <element> <path value="OperationOutcome.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="OperationOutcome.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="OperationOutcome.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="OperationOutcome.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="OperationOutcome.issue"/> <definition> <short value="A single issue associated with the action"/> <formal value="An error, warning or information message that results from a system action."/> <min value="1"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="AcknowledgementDetail or Observation[classCode="ALRT" and moodCode="EVN"]"/> </mapping> <mapping> <identity value="v2"/> <map value="ERR"/> </mapping> </definition> </element> <element> <path value="OperationOutcome.issue.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="OperationOutcome.issue.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="OperationOutcome.issue.severity"/> <definition> <short value="fatal | error | warning | information"/> <formal value="Indicates whether the issue indicates a variation from successful processing."/> <comments value="This is labeled as "Is Modifier" because applications should not confuse hints and warnings with errors."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="IssueSeverity"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/issue-severity"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="./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&qu ot;]"/> </mapping> <mapping> <identity value="v2"/> <map value="ERR-4"/> </mapping> </definition> </element> <element> <path value="OperationOutcome.issue.type"/> <definition> <short value="Error or warning code"/> <formal value="A code indicating the type of error, warning or information message."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="Coding"/> </type> <isModifier value="false"/> <binding> <name value="IssueType"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/issue-type"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="./code"/> </mapping> <mapping> <identity value="v2"/> <map value="ERR-3, ERR-5"/> </mapping> </definition> </element> <element> <path value="OperationOutcome.issue.details"/> <definition> <short value="Additional description of the issue"/> <formal value="Additional description of the issue."/> <comments value="typically this field is used to provide details human-readable information about the error."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./text[parent::AcknowledgmentDetail]"/> </mapping> <mapping> <identity value="v2"/> <map value="ERR-8"/> </mapping> </definition> </element> <element> <path value="OperationOutcome.issue.location"/> <definition> <short value="XPath of element(s) related to issue"/> <formal value="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 value="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 value="0"/> <max value="*"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./location[parent::AcknowledgmentDetail]"/> </mapping> <mapping> <identity value="v2"/> <map value="ERR-2"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="operationoutcome-definitions.html#OperationOutcome" title="A collection of error, warning or information messages that result from a system action."><b>OperationOutcome</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="operationoutcome-definitions.html#OperationOutcome.issue" title="An error, warning or information message that results from a system action."><b>issue</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>1..*</b></span> A single issue associated with the action --></span> <<a class="dict" href="operationoutcome-definitions.html#OperationOutcome.issue.severity" title="Indicates whether the issue indicates a variation from successful processing (this element modifies the meaning of other elements)"><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 href="issue-severity.html" style="color: navy">fatal | error | warning | information</a></span><span style="color: Gray"> --></span> <<a class="dict" href="operationoutcome-definitions.html#OperationOutcome.issue.type" title="A code indicating the type of error, warning or information message."><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 href="issue-type.html" style="color: navy">Error or warning code</a></span><span style="color: Gray"> --></span></type> <<a class="dict" href="operationoutcome-definitions.html#OperationOutcome.issue.details" title="Additional description of the issue."><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> <<a class="dict" href="operationoutcome-definitions.html#OperationOutcome.issue.location" 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."><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> </issue> </OperationOutcome> </pre></div> </summary> </entry> <entry> <title>"order" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/order</id> <link href="http://hl7.org/implement/standards/fhir/order.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="order-definitions.html#Order" title="A request to perform an action."><b>Order</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="order-definitions.html#Order.identifier" title="Identifiers assigned to this order by the orderer or by the receiver."><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 by the orderer or by the receiver</span><span style="color: Gray"> --></span></identifier> <<a class="dict" href="order-definitions.html#Order.date" title="When the order was made."><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> <<a class="dict" href="order-definitions.html#Order.subject" title="Patient this order is about."><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> <<a class="dict" href="order-definitions.html#Order.source" title="Who initiated the order."><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> <<a class="dict" href="order-definitions.html#Order.target" title="Who is intended to fulfill the order."><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"> Who is intended to fulfill the order</span><span style="color: Gray"> --></span></target> <<a class="dict" href="order-definitions.html#Order.reason_x_" title="Text - why the order was made."><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]> <<a class="dict" href="order-definitions.html#Order.authority" title="If required by policy."><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> <<a class="dict" href="order-definitions.html#Order.when" title="When order should be fulfilled."><b>when</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..1</b></span> When order should be fulfilled --></span> <<a class="dict" href="order-definitions.html#Order.when.code" title="Code specifies when request should be done. The code may simply be a priority code."><b>code</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: Provide a code or a schedule, but not both"><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"> Code specifies when request should be done. The code may simply be a priority code</span><span style="color: Gray"> --></span></code> <<a class="dict" href="order-definitions.html#Order.when.schedule" title="A formal schedule."><b>schedule</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: Provide a code or a schedule, but not both"><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> </when> <<a class="dict" href="order-definitions.html#Order.detail" title="What action is being ordered."><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> </Order> </pre></div> </text> <name value="order"/> <publisher value="FHIR Project"/> <description value="Basic Profile. A request to perform an action."/> <status value="draft"/> <date value="2014-09-30"/> <requirements value="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. Note 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 value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <structure> <type value="Order"/> <publish value="true"/> <element> <path value="Order"/> <definition> <short value="A request to perform an action"/> <formal value="A request to perform an action."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="ControlAct[classCode=ACTN, moodCode=RQO]"/> </mapping> </definition> </element> <element> <path value="Order.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Order.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Order.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Order.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Order.identifier"/> <definition> <short value="Identifiers assigned to this order by the orderer or by the receiver"/> <formal value="Identifiers assigned to this order by the orderer or by the receiver."/> <min value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> </definition> </element> <element> <path value="Order.date"/> <definition> <short value="When the order was made"/> <formal value="When the order was made."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=AUT].time"/> </mapping> <mapping> <identity value="v2"/> <map value="ORC-9"/> </mapping> </definition> </element> <element> <path value="Order.subject"/> <definition> <short value="Patient this order is about"/> <formal value="Patient this order is about."/> <comments value="May be left blank if the request reference identifies the patient, or if the request is not associated with a patient."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=SBJ].role[classCode=PAT]"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-3"/> </mapping> </definition> </element> <element> <path value="Order.source"/> <definition> <short value="Who initiated the order"/> <formal value="Who initiated the order."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=AUT].role"/> </mapping> <mapping> <identity value="v2"/> <map value="ORC-12 / OBR-16 / RXO-14 / RXE-13 / PRT-5 (PRT-4-Participation='OP')"/> </mapping> </definition> </element> <element> <path value="Order.target"/> <definition> <short value="Who is intended to fulfill the order"/> <formal value="Who is intended to fulfill the order."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Organization"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Device"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=PFM].role"/> </mapping> <mapping> <identity value="v2"/> <map value="Unclear: MSH-5 / IPC-7 / BPO-8 / RXO-32 / RXE-40 / RXD-30 / RXG-11 / RXG-27 / PRT-8 (PRT-4-participa tion in { 'AP', 'DP', 'PO', 'RT' })"/> </mapping> </definition> </element> <element> <path value="Order.reason[x]"/> <definition> <short value="Text - why the order was made"/> <formal value="Text - why the order was made."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Any"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".reasonCode or .outboundRelationship[typeCode=RSON].target"/> </mapping> <mapping> <identity value="v2"/> <map value="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"/> </mapping> </definition> </element> <element> <path value="Order.authority"/> <definition> <short value="If required by policy"/> <formal value="If required by policy."/> <comments value="reference will be constrained when suitable targets exist."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Any"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=RESP].role"/> </mapping> <mapping> <identity value="v2"/> <map value="if ordering provider, then ORC-12, OBR-16, etc."/> </mapping> </definition> </element> <element> <path value="Order.when"/> <definition> <short value="When order should be fulfilled"/> <formal value="When order should be fulfilled."/> <min value="0"/> <max value="1"/> <constraint> <key value="1"/> <name value="Scheduling Details"/> <severity value="error"/> <human value="Provide a code or a schedule, but not both"/> <xpath value="exists(f:code) != exists(f:schedule)"/> </constraint> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".effectiveTime"/> </mapping> <mapping> <identity value="v2"/> <map value="TQ1, TQ2"/> </mapping> </definition> </element> <element> <path value="Order.when.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Order.when.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Order.when.code"/> <definition> <short value="Code specifies when request should be done. The code may simply be a priority code"/> <formal value="Code specifies when request should be done. The code may simply be a priority code."/> <comments value="This is usually a local code agreed in the context of the ordering workflow."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="RequestedTime"/> <isExtensible value="true"/> <conformance value="preferred"/> <description value="When a requested action should be performed. E.g. STAT, daily, evenings, etc."/> </binding> <mapping> <identity value="rim"/> <map value="GTS is a coded value"/> </mapping> </definition> </element> <element> <path value="Order.when.schedule"/> <definition> <short value="A formal schedule"/> <formal value="A formal schedule."/> <min value="0"/> <max value="1"/> <type> <code value="Schedule"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="GTS is a complex schedule"/> </mapping> </definition> </element> <element> <path value="Order.detail"/> <definition> <short value="What action is being ordered"/> <formal value="What action is being ordered."/> <min value="1"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Any"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=SUBJ].target"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="authority"/> <type value="reference"/> <documentation value="If required by policy"/> <xpath value="f:Order/f:authority"/> </searchParam> <searchParam> <name value="date"/> <type value="date"/> <documentation value="When the order was made"/> <xpath value="f:Order/f:date"/> </searchParam> <searchParam> <name value="detail"/> <type value="reference"/> <documentation value="What action is being ordered"/> <xpath value="f:Order/f:detail"/> </searchParam> <searchParam> <name value="source"/> <type value="reference"/> <documentation value="Who initiated the order"/> <xpath value="f:Order/f:source"/> </searchParam> <searchParam> <name value="subject"/> <type value="reference"/> <documentation value="Patient this order is about"/> <xpath value="f:Order/f:subject"/> </searchParam> <searchParam> <name value="target"/> <type value="reference"/> <documentation value="Who is intended to fulfill the order"/> <xpath value="f:Order/f:target"/> </searchParam> <searchParam> <name value="when"/> <type value="date"/> <documentation value="A formal schedule"/> <xpath value="f:Order/f:when/f:schedule"/> </searchParam> <searchParam> <name value="when_code"/> <type value="token"/> <documentation value="Code specifies when request should be done. The code may simply be a priority code"/> <xpath value="f:Order/f:when/f:code"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="order-definitions.html#Order" title="A request to perform an action."><b>Order</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="order-definitions.html#Order.identifier" title="Identifiers assigned to this order by the orderer or by the receiver."><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 by the orderer or by the receiver</span><span style="color: Gray"> --></span></identifier> <<a class="dict" href="order-definitions.html#Order.date" title="When the order was made."><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> <<a class="dict" href="order-definitions.html#Order.subject" title="Patient this order is about."><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> <<a class="dict" href="order-definitions.html#Order.source" title="Who initiated the order."><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> <<a class="dict" href="order-definitions.html#Order.target" title="Who is intended to fulfill the order."><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"> Who is intended to fulfill the order</span><span style="color: Gray"> --></span></target> <<a class="dict" href="order-definitions.html#Order.reason_x_" title="Text - why the order was made."><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]> <<a class="dict" href="order-definitions.html#Order.authority" title="If required by policy."><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> <<a class="dict" href="order-definitions.html#Order.when" title="When order should be fulfilled."><b>when</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..1</b></span> When order should be fulfilled --></span> <<a class="dict" href="order-definitions.html#Order.when.code" title="Code specifies when request should be done. The code may simply be a priority code."><b>code</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: Provide a code or a schedule, but not both"><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"> Code specifies when request should be done. The code may simply be a priority code</span><span style="color: Gray"> --></span></code> <<a class="dict" href="order-definitions.html#Order.when.schedule" title="A formal schedule."><b>schedule</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: Provide a code or a schedule, but not both"><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> </when> <<a class="dict" href="order-definitions.html#Order.detail" title="What action is being ordered."><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> </Order> </pre></div> </summary> </entry> <entry> <title>"orderresponse" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/orderresponse</id> <link href="http://hl7.org/implement/standards/fhir/orderresponse.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="orderresponse-definitions.html#OrderResponse" title="A response to an order."><b>OrderResponse</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="orderresponse-definitions.html#OrderResponse.identifier" 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."><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 by the orderer or by the receiver</span><span style="color: Gray"> --></span></identifier> <<a class="dict" href="orderresponse-definitions.html#OrderResponse.request" title="A reference to the order that this is in response to."><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> <<a class="dict" href="orderresponse-definitions.html#OrderResponse.date" title="The date and time at which this order response was made (created/posted)."><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> <<a class="dict" href="orderresponse-definitions.html#OrderResponse.who" title="The person, organization, or device credited with making the response."><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> <<a class="dict" href="orderresponse-definitions.html#OrderResponse.authority_x_" 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."><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]> <<a class="dict" href="orderresponse-definitions.html#OrderResponse.code" title="What this response says about the status of the original order (this element modifies the meaning of other elements)"><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 href="order-outcome-code.html" style="color: navy">pending | review | rejected | error | accepted | cancelled | replaced | aborted | complete</a></span><span style="color: Gray"> --></span> <<a class="dict" href="orderresponse-definitions.html#OrderResponse.description" title="Additional description about the response - e.g. a text description provided by a human user when making decisions about the order."><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> <<a class="dict" href="orderresponse-definitions.html#OrderResponse.fulfillment" 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."><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> </OrderResponse> </pre></div> </text> <name value="orderresponse"/> <publisher value="FHIR Project"/> <description value="Basic Profile. A response to an order."/> <status value="draft"/> <date value="2014-09-30"/> <requirements value="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 value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <structure> <type value="OrderResponse"/> <publish value="true"/> <element> <path value="OrderResponse"/> <definition> <short value="A response to an order"/> <formal value="A response to an order."/> <comments value="There might be more than one response to an order."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="ControlAct[classCode=ACTN, moodCode=EVN]"/> </mapping> </definition> </element> <element> <path value="OrderResponse.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="OrderResponse.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="OrderResponse.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="OrderResponse.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="OrderResponse.identifier"/> <definition> <short value="Identifiers assigned to this order by the orderer or by the receiver"/> <formal value="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 value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> </definition> </element> <element> <path value="OrderResponse.request"/> <definition> <short value="The order that this is a response to"/> <formal value="A reference to the order that this is in response to."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Order"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationships[typeCode=FLFS].target"/> </mapping> <mapping> <identity value="v2"/> <map value="ORC-2 / ORC-3, or OBR-2 | OBR-3"/> </mapping> </definition> </element> <element> <path value="OrderResponse.date"/> <definition> <short value="When the response was made"/> <formal value="The date and time at which this order response was made (created/posted)."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=AUT].time"/> </mapping> <mapping> <identity value="v2"/> <map value="ORC-9"/> </mapping> </definition> </element> <element> <path value="OrderResponse.who"/> <definition> <short value="Who made the response"/> <formal value="The person, organization, or device credited with making the response."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Organization"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Device"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=AUT].role"/> </mapping> <mapping> <identity value="v2"/> <map value="Practitioner: ORC-19 | PRT / Organization: PRT"/> </mapping> </definition> </element> <element> <path value="OrderResponse.authority[x]"/> <definition> <short value="If required by policy"/> <formal value="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 value="reference will be constrained when suitable targets exist."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Any"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationships[typeCode=COVBY].target[classCode=POLICY, moodCode=EVN].code or .outboundRelationships[typeCode=COVBY].target[classCode=POLICY, moodCode=EVN]"/> </mapping> <mapping> <identity value="v2"/> <map value="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"/> </mapping> </definition> </element> <element> <path value="OrderResponse.code"/> <definition> <short value="pending | review | rejected | error | accepted | cancelled | replaced | aborted | complete"/> <formal value="What this response says about the status of the original order."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="OrderOutcomeStatus"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/order-outcome-code"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".code (different trigger events for different outcomes)"/> </mapping> <mapping> <identity value="v2"/> <map value="ORC-1 + ORC-5"/> </mapping> </definition> </element> <element> <path value="OrderResponse.description"/> <definition> <short value="Additional description of the response"/> <formal value="Additional description about the response - e.g. a text description provided by a human user when making decisions about the order."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".text"/> </mapping> <mapping> <identity value="v2"/> <map value="ORC-16.2-order control code reason.text"/> </mapping> </definition> </element> <element> <path value="OrderResponse.fulfillment"/> <definition> <short value="Details of the outcome of performing the order"/> <formal value="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 value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Any"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=SUBJ]/target[moodCode=RQO]"/> </mapping> <mapping> <identity value="v2"/> <map value="OBR+OBX[n] / RXE / RXD / RXG / RXA / BPX / BTX"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="code"/> <type value="token"/> <documentation value="pending | review | rejected | error | accepted | cancelled | replaced | aborted | complete"/> <xpath value="f:OrderResponse/f:code"/> </searchParam> <searchParam> <name value="date"/> <type value="date"/> <documentation value="When the response was made"/> <xpath value="f:OrderResponse/f:date"/> </searchParam> <searchParam> <name value="fulfillment"/> <type value="reference"/> <documentation value="Details of the outcome of performing the order"/> <xpath value="f:OrderResponse/f:fulfillment"/> </searchParam> <searchParam> <name value="request"/> <type value="reference"/> <documentation value="The order that this is a response to"/> <xpath value="f:OrderResponse/f:request"/> </searchParam> <searchParam> <name value="who"/> <type value="reference"/> <documentation value="Who made the response"/> <xpath value="f:OrderResponse/f:who"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="orderresponse-definitions.html#OrderResponse" title="A response to an order."><b>OrderResponse</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="orderresponse-definitions.html#OrderResponse.identifier" 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."><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 by the orderer or by the receiver</span><span style="color: Gray"> --></span></identifier> <<a class="dict" href="orderresponse-definitions.html#OrderResponse.request" title="A reference to the order that this is in response to."><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> <<a class="dict" href="orderresponse-definitions.html#OrderResponse.date" title="The date and time at which this order response was made (created/posted)."><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> <<a class="dict" href="orderresponse-definitions.html#OrderResponse.who" title="The person, organization, or device credited with making the response."><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> <<a class="dict" href="orderresponse-definitions.html#OrderResponse.authority_x_" 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."><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]> <<a class="dict" href="orderresponse-definitions.html#OrderResponse.code" title="What this response says about the status of the original order (this element modifies the meaning of other elements)"><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 href="order-outcome-code.html" style="color: navy">pending | review | rejected | error | accepted | cancelled | replaced | aborted | complete</a></span><span style="color: Gray"> --></span> <<a class="dict" href="orderresponse-definitions.html#OrderResponse.description" title="Additional description about the response - e.g. a text description provided by a human user when making decisions about the order."><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> <<a class="dict" href="orderresponse-definitions.html#OrderResponse.fulfillment" 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."><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> </OrderResponse> </pre></div> </summary> </entry> <entry> <title>"organization" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/organization</id> <link href="http://hl7.org/implement/standards/fhir/organization.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="organization-definitions.html#Organization" 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."><b>Organization</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="organization-definitions.html#Organization.identifier" title="Identifier for the organization that is used to identify the organization across multiple disparate systems."><b>identifier</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: The organization SHALL at least have a name or an id, and possibly more than one"><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> <<a class="dict" href="organization-definitions.html#Organization.name" title="A name associated with the organization."><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" title="Inv-1: The organization SHALL at least have a name or an id, and possibly more than one"><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> <<a class="dict" href="organization-definitions.html#Organization.type" title="The kind of organization that this is."><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 href="valueset-organization-type.html" style="color: navy">Kind of organization</a></span><span style="color: Gray"> --></span></type> <<a class="dict" href="organization-definitions.html#Organization.telecom" title="A contact detail for the organization."><b>telecom</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-3: The telecom of an organization can never be of use 'home'"><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> <<a class="dict" href="organization-definitions.html#Organization.address" title="An address for the organization."><b>address</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-2: An address of an organization can never be of use 'home'"><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> <<a class="dict" href="organization-definitions.html#Organization.partOf" title="The organization of which this organization forms a part."><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"> The organization of which this organization forms a part</span><span style="color: Gray"> --></span></partOf> <<a class="dict" href="organization-definitions.html#Organization.contact" title="Contact for the organization for a certain purpose."><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> <<a class="dict" href="organization-definitions.html#Organization.contact.purpose" title="Indicates a purpose for which the contact can be reached."><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 href="valueset-contactentity-type.html" style="color: navy">The type of contact</a></span><span style="color: Gray"> --></span></purpose> <<a class="dict" href="organization-definitions.html#Organization.contact.name" title="A name associated with the contact."><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> <<a class="dict" href="organization-definitions.html#Organization.contact.telecom" title="A contact detail (e.g. a telephone number or an email address) by which the party may be contacted."><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> <<a class="dict" href="organization-definitions.html#Organization.contact.address" title="Visiting or postal addresses for the contact."><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> <<a class="dict" href="organization-definitions.html#Organization.contact.gender" title="Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes."><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 href="valueset-administrative-gender.html" style="color: navy">Gender for administrative purposes</a></span><span style="color: Gray"> --></span></gender> </contact> <<a class="dict" href="organization-definitions.html#Organization.location" title="Location(s) the organization uses to provide services."><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"> Location(s) the organization uses to provide services</span><span style="color: Gray"> --></span></location> <<a class="dict" href="organization-definitions.html#Organization.active" title="Whether the organization's record is still in active use (this element modifies the meaning of other elements)"><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> </Organization> </pre></div> </text> <name value="organization"/> <publisher value="FHIR Project"/> <description value="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 value="draft"/> <date value="2014-09-30"/> <requirements value="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 value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <mapping> <identity value="servd"/> <uri value="http://www.omg.org/spec/ServD/1.0/"/> <name value="ServD"/> </mapping> <structure> <type value="Organization"/> <publish value="true"/> <element> <path value="Organization"/> <definition> <short value="A grouping of people or organizations with a common purpose"/> <formal value="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 value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <constraint> <key value="1"/> <name value="AtLeastANameOrId"/> <severity value="error"/> <human value="The organization SHALL at least have a name or an id, and possibly more than one"/> <xpath value="count(f:identifier | f:name) > 0"/> </constraint> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Organization(classCode=ORG, determinerCode=INST)"/> </mapping> <mapping> <identity value="v2"/> <map value="(also see master files messages)"/> </mapping> <mapping> <identity value="servd"/> <map value="Organization"/> </mapping> </definition> </element> <element> <path value="Organization.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Organization.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Organization.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Organization.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Organization.identifier"/> <definition> <short value="Identifies this organization across multiple systems"/> <formal value="Identifier for the organization that is used to identify the organization across multiple disparate systems."/> <min value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".scopes[Role](classCode=IDENT)"/> </mapping> <mapping> <identity value="v2"/> <map value="XON.10 Organization Identifier / XON.3 ID Number"/> </mapping> <mapping> <identity value="servd"/> <map value="./Identifiers"/> </mapping> </definition> </element> <element> <path value="Organization.name"/> <definition> <short value="Name used for the organization"/> <formal value="A name associated with the organization."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".name"/> </mapping> <mapping> <identity value="v2"/> <map value="XON.1 Organization Name"/> </mapping> <mapping> <identity value="servd"/> <map value=".PreferredName/Name"/> </mapping> </definition> </element> <element> <path value="Organization.type"/> <definition> <short value="Kind of organization"/> <formal value="The kind of organization that this is."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="OrganizationType"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/organization-type"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> <mapping> <identity value="v2"/> <map value="No equivalent in v2"/> </mapping> <mapping> <identity value="servd"/> <map value="n/a"/> </mapping> </definition> </element> <element> <path value="Organization.telecom"/> <definition> <short value="A contact detail for the organization"/> <formal value="A contact detail for the organization."/> <comments value="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 value="0"/> <max value="*"/> <type> <code value="Contact"/> </type> <constraint> <key value="3"/> <name value="NoHomeUseTelecom"/> <severity value="error"/> <human value="The telecom of an organization can never be of use 'home'"/> <xpath value="count(f:use[@value='home']) = 0"/> </constraint> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".telecom"/> </mapping> <mapping> <identity value="v2"/> <map value="No authoritative equivalent in V2.x"/> </mapping> <mapping> <identity value="servd"/> <map value="./ContactPoints"/> </mapping> </definition> </element> <element> <path value="Organization.address"/> <definition> <short value="An address for the organization"/> <formal value="An address for the organization."/> <comments value="Organization may have multiple addresses with different uses or applicable periods. The use code home is not to be used."/> <min value="0"/> <max value="*"/> <type> <code value="Address"/> </type> <constraint> <key value="2"/> <name value="NoHomeUseAddress"/> <severity value="error"/> <human value="An address of an organization can never be of use 'home'"/> <xpath value="count(f:use[@value='home']) = 0"/> </constraint> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".address"/> </mapping> <mapping> <identity value="v2"/> <map value="No authoritative equivalent in V2.x; some V2.x segments such as OBX might provide a serialized instance value"/> </mapping> <mapping> <identity value="servd"/> <map value="./PrimaryAddress and ./OtherAddresses"/> </mapping> </definition> </element> <element> <path value="Organization.partOf"/> <definition> <short value="The organization of which this organization forms a part"/> <formal value="The organization of which this organization forms a part."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Organization"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".playedBy[classCode=Part].scoper"/> </mapping> <mapping> <identity value="v2"/> <map value="No equivalent in V2.x"/> </mapping> <mapping> <identity value="servd"/> <map value="n/a"/> </mapping> </definition> </element> <element> <path value="Organization.contact"/> <definition> <short value="Contact for the organization for a certain purpose"/> <formal value="Contact for the organization for a certain purpose."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".contactParty"/> </mapping> </definition> </element> <element> <path value="Organization.contact.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Organization.contact.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Organization.contact.purpose"/> <definition> <short value="The type of contact"/> <formal value="Indicates a purpose for which the contact can be reached."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="ContactPartyType"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/contactentity-type"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="./type"/> </mapping> </definition> </element> <element> <path value="Organization.contact.name"/> <definition> <short value="A name associated with the contact"/> <formal value="A name associated with the contact."/> <min value="0"/> <max value="1"/> <type> <code value="HumanName"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./name"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-5, PID-9"/> </mapping> </definition> </element> <element> <path value="Organization.contact.telecom"/> <definition> <short value="Contact details (telephone, email, etc) for a contact"/> <formal value="A contact detail (e.g. a telephone number or an email address) by which the party may be contacted."/> <min value="0"/> <max value="*"/> <type> <code value="Contact"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./telecom"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-13, PID-14"/> </mapping> </definition> </element> <element> <path value="Organization.contact.address"/> <definition> <short value="Visiting or postal addresses for the contact"/> <formal value="Visiting or postal addresses for the contact."/> <min value="0"/> <max value="1"/> <type> <code value="Address"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./addr"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-11"/> </mapping> </definition> </element> <element> <path value="Organization.contact.gender"/> <definition> <short value="Gender for administrative purposes"/> <formal value="Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="AdministrativeGender"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/administrative-gender"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="./administrativeGender"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-8"/> </mapping> </definition> </element> <element> <path value="Organization.location"/> <definition> <short value="Location(s) the organization uses to provide services"/> <formal value="Location(s) the organization uses to provide services."/> <min value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Location"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".scopedBy[classCode=LocatedEntity].scoper"/> </mapping> <mapping> <identity value="servd"/> <map value="./Sites"/> </mapping> </definition> </element> <element> <path value="Organization.active"/> <definition> <short value="Whether the organization's record is still in active use"/> <formal value="Whether the organization's record is still in active use."/> <comments value="Default is true."/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value=".status"/> </mapping> <mapping> <identity value="v2"/> <map value="No equivalent in V2.x"/> </mapping> <mapping> <identity value="servd"/> <map value="./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."/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="active"/> <type value="token"/> <documentation value="Whether the organization's record is active"/> <xpath value="f:Organization/f:active"/> </searchParam> <searchParam> <name value="identifier"/> <type value="token"/> <documentation value="Any identifier for the organization (not the accreditation issuer's identifier)"/> <xpath value="f:Organization/f:identifier"/> </searchParam> <searchParam> <name value="name"/> <type value="string"/> <documentation value="A portion of the organization's name"/> <xpath value="f:Organization/f:name"/> </searchParam> <searchParam> <name value="partof"/> <type value="reference"/> <documentation value="Search all organizations that are part of the given organization"/> <xpath value="f:Organization/f:partOf"/> </searchParam> <searchParam> <name value="phonetic"/> <type value="string"/> <documentation value="A portion of the organization's name using some kind of phonetic matching algorithm"/> </searchParam> <searchParam> <name value="type"/> <type value="token"/> <documentation value="A code for the type of organization"/> <xpath value="f:Organization/f:type"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="organization-definitions.html#Organization" 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."><b>Organization</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="organization-definitions.html#Organization.identifier" title="Identifier for the organization that is used to identify the organization across multiple disparate systems."><b>identifier</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: The organization SHALL at least have a name or an id, and possibly more than one"><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> <<a class="dict" href="organization-definitions.html#Organization.name" title="A name associated with the organization."><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" title="Inv-1: The organization SHALL at least have a name or an id, and possibly more than one"><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> <<a class="dict" href="organization-definitions.html#Organization.type" title="The kind of organization that this is."><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 href="valueset-organization-type.html" style="color: navy">Kind of organization</a></span><span style="color: Gray"> --></span></type> <<a class="dict" href="organization-definitions.html#Organization.telecom" title="A contact detail for the organization."><b>telecom</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-3: The telecom of an organization can never be of use 'home'"><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> <<a class="dict" href="organization-definitions.html#Organization.address" title="An address for the organization."><b>address</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-2: An address of an organization can never be of use 'home'"><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> <<a class="dict" href="organization-definitions.html#Organization.partOf" title="The organization of which this organization forms a part."><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"> The organization of which this organization forms a part</span><span style="color: Gray"> --></span></partOf> <<a class="dict" href="organization-definitions.html#Organization.contact" title="Contact for the organization for a certain purpose."><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> <<a class="dict" href="organization-definitions.html#Organization.contact.purpose" title="Indicates a purpose for which the contact can be reached."><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 href="valueset-contactentity-type.html" style="color: navy">The type of contact</a></span><span style="color: Gray"> --></span></purpose> <<a class="dict" href="organization-definitions.html#Organization.contact.name" title="A name associated with the contact."><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> <<a class="dict" href="organization-definitions.html#Organization.contact.telecom" title="A contact detail (e.g. a telephone number or an email address) by which the party may be contacted."><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> <<a class="dict" href="organization-definitions.html#Organization.contact.address" title="Visiting or postal addresses for the contact."><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> <<a class="dict" href="organization-definitions.html#Organization.contact.gender" title="Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes."><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 href="valueset-administrative-gender.html" style="color: navy">Gender for administrative purposes</a></span><span style="color: Gray"> --></span></gender> </contact> <<a class="dict" href="organization-definitions.html#Organization.location" title="Location(s) the organization uses to provide services."><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"> Location(s) the organization uses to provide services</span><span style="color: Gray"> --></span></location> <<a class="dict" href="organization-definitions.html#Organization.active" title="Whether the organization's record is still in active use (this element modifies the meaning of other elements)"><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> </Organization> </pre></div> </summary> </entry> <entry> <title>"other" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/other</id> <link href="http://hl7.org/implement/standards/fhir/other.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="other-definitions.html#Other" title="Other is a conformant for handling resource concepts not yet defined for FHIR or outside HL7's scope of interest."><b>Other</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="other-definitions.html#Other.identifier" title="Identifier assigned to the resource for business purposes, outside the context of FHIR."><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> <<a class="dict" href="other-definitions.html#Other.code" title="Identifies the 'type' of resource - equivalent to the resource name for other resources (this element modifies the meaning of other elements)"><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 href="valueset-other-resource-type.html" style="color: navy">Kind of Resource</a></span><span style="color: Gray"> --></span></code> <<a class="dict" href="other-definitions.html#Other.subject" title="Identifies the patient, practitioner, device or any other resource that is the "focus" of this resoruce."><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> <<a class="dict" href="other-definitions.html#Other.author" title="Indicates who was responsible for creating the resource instance."><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> <<a class="dict" href="other-definitions.html#Other.created" title="Identifies when the resource was first 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> </Other> </pre></div> </text> <name value="other"/> <publisher value="FHIR Project"/> <description value="Basic Profile. Other is a conformant for handling resource concepts not yet defined for FHIR or outside HL7's scope of interest."/> <status value="draft"/> <date value="2014-09-30"/> <requirements value="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. The Other resource is intended for use in two circumstances: * 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.) * 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. There'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. Implementers 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 value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <structure> <type value="Other"/> <publish value="true"/> <element> <path value="Other"/> <definition> <short value="Resource for non-supported content"/> <formal value="Other is a conformant for handling resource concepts not yet defined for FHIR or outside HL7's scope of interest."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Act, Entity or Role"/> </mapping> </definition> </element> <element> <path value="Other.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Other.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Other.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Other.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Other.identifier"/> <definition> <short value="Business identifier"/> <formal value="Identifier assigned to the resource for business purposes, outside the context of FHIR."/> <min value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./identifier"/> </mapping> </definition> </element> <element> <path value="Other.code"/> <definition> <short value="Kind of Resource"/> <formal value="Identifies the 'type' of resource - equivalent to the resource name for other resources."/> <comments value="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 value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="true"/> <binding> <name value="OtherResourceType"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/other-resource-type"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="./code"/> </mapping> </definition> </element> <element> <path value="Other.subject"/> <definition> <short value="Identifies the"/> <formal value="Identifies the patient, practitioner, device or any other resource that is the "focus" of this resoruce."/> <comments value="Optional as not all resources potential resources will have subjects. Resources associated with multiple subjects can handle this via extension."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Any"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./participation[typeCode='SBJ'] (possibly through a ControlAct and Role)"/> </mapping> </definition> </element> <element> <path value="Other.author"/> <definition> <short value="Who created"/> <formal value="Indicates who was responsible for creating the resource instance."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/RelatedPerson"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./participation[typeCode='SUB'] (possibly through a ControlAct and Role)"/> </mapping> </definition> </element> <element> <path value="Other.created"/> <definition> <short value="When created"/> <formal value="Identifies when the resource was first created."/> <min value="0"/> <max value="1"/> <type> <code value="date"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./participation[typeCode='AUT']/time (possibly through a ControlAct and Role)"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="code"/> <type value="token"/> <documentation value="Kind of Resource"/> <xpath value="f:Other/f:code"/> </searchParam> <searchParam> <name value="created"/> <type value="date"/> <documentation value="When created"/> <xpath value="f:Other/f:created"/> </searchParam> <searchParam> <name value="subject"/> <type value="reference"/> <documentation value="Identifies the"/> <xpath value="f:Other/f:subject"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="other-definitions.html#Other" title="Other is a conformant for handling resource concepts not yet defined for FHIR or outside HL7's scope of interest."><b>Other</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="other-definitions.html#Other.identifier" title="Identifier assigned to the resource for business purposes, outside the context of FHIR."><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> <<a class="dict" href="other-definitions.html#Other.code" title="Identifies the 'type' of resource - equivalent to the resource name for other resources (this element modifies the meaning of other elements)"><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 href="valueset-other-resource-type.html" style="color: navy">Kind of Resource</a></span><span style="color: Gray"> --></span></code> <<a class="dict" href="other-definitions.html#Other.subject" title="Identifies the patient, practitioner, device or any other resource that is the "focus" of this resoruce."><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> <<a class="dict" href="other-definitions.html#Other.author" title="Indicates who was responsible for creating the resource instance."><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> <<a class="dict" href="other-definitions.html#Other.created" title="Identifies when the resource was first 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> </Other> </pre></div> </summary> </entry> <entry> <title>"patient" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/patient</id> <link href="http://hl7.org/implement/standards/fhir/patient.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="patient-definitions.html#Patient" title="Demographics and other administrative information about a person or animal receiving care or other health-related services."><b>Patient</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="patient-definitions.html#Patient.identifier" title="An identifier that applies to this person as a patient."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></identifier> <<a class="dict" href="patient-definitions.html#Patient.name" title="A name associated with the individual."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></name> <<a class="dict" href="patient-definitions.html#Patient.telecom" title="A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></telecom> <<a class="dict" href="patient-definitions.html#Patient.gender" title="Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes."><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 href="valueset-administrative-gender.html" style="color: navy">Gender for administrative purposes<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></gender> <<a class="dict" href="patient-definitions.html#Patient.birthDate" title="The date and time of birth for the individual."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="patient-definitions.html#Patient.deceased_x_" title="Indicates if the individual is deceased or not (this element modifies the meaning of other elements)"><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></deceased[x]> <<a class="dict" href="patient-definitions.html#Patient.address" title="Addresses for the individual."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></address> <<a class="dict" href="patient-definitions.html#Patient.maritalStatus" title="This field contains a patient's most recent marital (civil) status."><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 href="valueset-marital-status.html" style="color: navy">Marital (civil) status of a person<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></maritalStatus> <<a class="dict" href="patient-definitions.html#Patient.multipleBirth_x_" title="Indicates whether the patient is part of a multiple or indicates the actual birth order."><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"> Whether patient is part of a multiple birth<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></multipleBirth[x]> <<a class="dict" href="patient-definitions.html#Patient.photo" title="Image of the person."><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> <<a class="dict" href="patient-definitions.html#Patient.contact" title="A contact party (e.g. guardian, partner, friend) for the patient."><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> <<a class="dict" href="patient-definitions.html#Patient.contact.relationship" title="The nature of the relationship between the patient and the contact person."><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 href="valueset-patient-contact-relationship.html" style="color: navy">The kind of relationship</a></span><span style="color: Gray"> --></span></relationship> <<a class="dict" href="patient-definitions.html#Patient.contact.name" title="A name associated with the person."><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> <<a class="dict" href="patient-definitions.html#Patient.contact.telecom" title="A contact detail for the person, e.g. a telephone number or an email address."><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> <<a class="dict" href="patient-definitions.html#Patient.contact.address" title="Address for the contact person."><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> <<a class="dict" href="patient-definitions.html#Patient.contact.gender" title="Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes."><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 href="valueset-administrative-gender.html" style="color: navy">Gender for administrative purposes</a></span><span style="color: Gray"> --></span></gender> <<a class="dict" href="patient-definitions.html#Patient.contact.organization" title="Organization on behalf of which the contact is acting or for which the contact is working."><b>organization</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: SHALL at least contain a contact's details or a reference to an organization"><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"> Organization that is associated with the contact</span><span style="color: Gray"> --></span></organization> </contact> <<a class="dict" href="patient-definitions.html#Patient.animal" title="This element has a value if the patient is an animal (this element modifies the meaning of other elements)"><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span> --></span> <<a class="dict" href="patient-definitions.html#Patient.animal.species" title="Identifies the high level categorization of the kind of animal."><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 href="valueset-animal-species.html" style="color: navy">E.g. Dog, Cow<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></species> <<a class="dict" href="patient-definitions.html#Patient.animal.breed" title="Identifies the detailed categorization of the kind of animal."><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 href="valueset-animal-breeds.html" style="color: navy">E.g. Poodle, Angus<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></breed> <<a class="dict" href="patient-definitions.html#Patient.animal.genderStatus" title="Indicates the current state of the animal's reproductive organs."><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 href="valueset-animal-genderstatus.html" style="color: navy">E.g. Neutered, Intact<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></genderStatus> </animal> <<a class="dict" href="patient-definitions.html#Patient.communication" title="Languages which may be used to communicate with the patient about his or her health."><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 href="http://tools.ietf.org/html/bcp47.html" style="color: navy">Languages which may be used to communicate with the patient about his or her health</a></span><span style="color: Gray"> --></span></communication> <<a class="dict" href="patient-definitions.html#Patient.careProvider" title="Patient's nominated care provider."><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"> Patient's nominated care provider</span><span style="color: Gray"> --></span></careProvider> <<a class="dict" href="patient-definitions.html#Patient.managingOrganization" title="Organization that is the custodian of the patient record."><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"> Organization that is the custodian of the patient record<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></managingOrganization> <<a class="dict" href="patient-definitions.html#Patient.link" title="Link to another patient resource that concerns the same actual person (this element modifies the meaning of other elements)"><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span> --></span> <<a class="dict" href="patient-definitions.html#Patient.link.other" title="The other patient resource that the link refers to (this element modifies the meaning of other elements)"><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></other> <<a class="dict" href="patient-definitions.html#Patient.link.type" title="The type of link between this patient resource and another patient resource (this element modifies the meaning of other elements)"><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 href="link-type.html" style="color: navy">replace | refer | seealso - type of link<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span> </link> <<a class="dict" href="patient-definitions.html#Patient.active" title="Whether this patient record is in active use (this element modifies the meaning of other elements)"><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> </Patient> </pre></div> </text> <name value="patient"/> <publisher value="FHIR Project"/> <description value="Basic Profile. Demographics and other administrative information about a person or animal receiving care or other health-related services."/> <status value="draft"/> <date value="2014-09-30"/> <requirements value="Scope and Usage This Resource covers data about persons and animals involved in a wide range of health-related activities, including: * Curative activities * Psychiatric care * Social services * Pregnancy care * Nursing and assisted living * Dietary services * Tracking of personal health and exercise data The 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 value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <structure> <type value="Patient"/> <publish value="true"/> <element> <path value="Patient"/> <definition> <short value="Information about a person or animal receiving health care services"/> <formal value="Demographics and other administrative information about a person or animal receiving care or other health-related services."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Patient[classCode=PAT]"/> </mapping> </definition> </element> <element> <path value="Patient.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Patient.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Patient.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Patient.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Patient.identifier"/> <definition> <short value="An identifier for the person as this patient"/> <formal value="An identifier that applies to this person as a patient."/> <min value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="id"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-3"/> </mapping> </definition> </element> <element> <path value="Patient.name"/> <definition> <short value="A name associated with the patient"/> <formal value="A name associated with the individual."/> <comments value="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 value="0"/> <max value="*"/> <type> <code value="HumanName"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="name"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-5, PID-9"/> </mapping> </definition> </element> <element> <path value="Patient.telecom"/> <definition> <short value="A contact detail for the individual"/> <formal value="A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted."/> <comments value="Person may have multiple ways to be contacted with different uses or applicable periods. May 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 value="0"/> <max value="*"/> <type> <code value="Contact"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="telecom"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-13, PID-14, PID-40"/> </mapping> </definition> </element> <element> <path value="Patient.gender"/> <definition> <short value="Gender for administrative purposes"/> <formal value="Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="AdministrativeGender"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/administrative-gender"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-8"/> </mapping> </definition> </element> <element> <path value="Patient.birthDate"/> <definition> <short value="The date and time of birth for the individual"/> <formal value="The date and time of birth for the individual."/> <comments value="At least an estimated year should be provided as a guess if the real dob is unknown."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-7"/> </mapping> </definition> </element> <element> <path value="Patient.deceased[x]"/> <definition> <short value="Indicates if the individual is deceased or not"/> <formal value="Indicates if the individual is deceased or not."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <type> <code value="dateTime"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-30 (bool) and PID-29 (datetime)"/> </mapping> </definition> </element> <element> <path value="Patient.address"/> <definition> <short value="Addresses for the individual"/> <formal value="Addresses for the individual."/> <comments value="Person may have multiple addresses with different uses or applicable periods."/> <min value="0"/> <max value="*"/> <type> <code value="Address"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="addr"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-11"/> </mapping> </definition> </element> <element> <path value="Patient.maritalStatus"/> <definition> <short value="Marital (civil) status of a person"/> <formal value="This field contains a patient's most recent marital (civil) status."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="MaritalStatus"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/marital-status"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="player[classCode=PSN]/maritalStatusCode"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-16"/> </mapping> </definition> </element> <element> <path value="Patient.multipleBirth[x]"/> <definition> <short value="Whether patient is part of a multiple birth"/> <formal value="Indicates whether the patient is part of a multiple or indicates the actual birth order."/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <type> <code value="integer"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-24 (bool), PID-25 (integer)"/> </mapping> </definition> </element> <element> <path value="Patient.photo"/> <definition> <short value="Image of the person"/> <formal value="Image of the person."/> <min value="0"/> <max value="*"/> <type> <code value="Attachment"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-5 - needs a profile"/> </mapping> </definition> </element> <element> <path value="Patient.contact"/> <definition> <short value="A contact party (e.g. guardian, partner, friend) for the patient"/> <formal value="A contact party (e.g. guardian, partner, friend) for the patient."/> <comments value="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 value="0"/> <max value="*"/> <constraint> <key value="1"/> <name value="ContactNeedsDetails"/> <severity value="error"/> <human value="SHALL at least contain a contact's details or a reference to an organization"/> <xpath value="f:name or f:telecom or f:address or f:organization"/> </constraint> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]"/> </mapping> </definition> </element> <element> <path value="Patient.contact.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Patient.contact.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Patient.contact.relationship"/> <definition> <short value="The kind of relationship"/> <formal value="The nature of the relationship between the patient and the contact person."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="ContactRelationship"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/patient-contact-relationship"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="code"/> </mapping> <mapping> <identity value="v2"/> <map value="NK1-7, NK1-3"/> </mapping> </definition> </element> <element> <path value="Patient.contact.name"/> <definition> <short value="A name associated with the person"/> <formal value="A name associated with the person."/> <min value="0"/> <max value="1"/> <type> <code value="HumanName"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="name"/> </mapping> <mapping> <identity value="v2"/> <map value="NK1-2"/> </mapping> </definition> </element> <element> <path value="Patient.contact.telecom"/> <definition> <short value="A contact detail for the person"/> <formal value="A contact detail for the person, e.g. a telephone number or an email address."/> <comments value="Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification."/> <min value="0"/> <max value="*"/> <type> <code value="Contact"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="telecom"/> </mapping> <mapping> <identity value="v2"/> <map value="NK1-5, NK1-6, NK1-40"/> </mapping> </definition> </element> <element> <path value="Patient.contact.address"/> <definition> <short value="Address for the contact person"/> <formal value="Address for the contact person."/> <min value="0"/> <max value="1"/> <type> <code value="Address"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="addr"/> </mapping> <mapping> <identity value="v2"/> <map value="NK1-4"/> </mapping> </definition> </element> <element> <path value="Patient.contact.gender"/> <definition> <short value="Gender for administrative purposes"/> <formal value="Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="AdministrativeGender"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/administrative-gender"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender"/> </mapping> <mapping> <identity value="v2"/> <map value="NK1-15"/> </mapping> </definition> </element> <element> <path value="Patient.contact.organization"/> <definition> <short value="Organization that is associated with the contact"/> <formal value="Organization on behalf of which the contact is acting or for which the contact is working."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Organization"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="scoper"/> </mapping> <mapping> <identity value="v2"/> <map value="NK1-13, NK1-30, NK1-31, NK1-32, NK1-41"/> </mapping> </definition> </element> <element> <path value="Patient.animal"/> <definition> <short value="If this patient is an animal (non-human)"/> <formal value="This element has a value if the patient is an animal."/> <comments value="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 value="0"/> <max value="1"/> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="player[classCode=ANM]"/> </mapping> </definition> </element> <element> <path value="Patient.animal.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Patient.animal.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Patient.animal.species"/> <definition> <short value="E.g. Dog, Cow"/> <formal value="Identifies the high level categorization of the kind of animal."/> <comments value="If the patient is non-human, at least a species SHALL be specified."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="AnimalSpecies"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/animal-species"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="code"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-35"/> </mapping> </definition> </element> <element> <path value="Patient.animal.breed"/> <definition> <short value="E.g. Poodle, Angus"/> <formal value="Identifies the detailed categorization of the kind of animal."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="AnimalBreed"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/animal-breeds"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="playedRole[classCode=GEN]/scoper[classCode=ANM, determinerCode=KIND]/code"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-37"/> </mapping> </definition> </element> <element> <path value="Patient.animal.genderStatus"/> <definition> <short value="E.g. Neutered, Intact"/> <formal value="Indicates the current state of the animal's reproductive organs."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="AnimalGenderStatus"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/animal-genderstatus"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="genderStatusCode"/> </mapping> <mapping> <identity value="v2"/> <map value="N/A"/> </mapping> </definition> </element> <element> <path value="Patient.communication"/> <definition> <short value="Languages which may be used to communicate with the patient about his or her health"/> <formal value="Languages which may be used to communicate with the patient about his or her health."/> <comments value="If no language is specified, this *implies* that the default local language is spoken. For animals, language is not a relevant field, and should be absent from the instance."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="Language"/> <isExtensible value="false"/> <conformance value="required"/> <referenceUri value="http://tools.ietf.org/html/bcp47"/> </binding> <mapping> <identity value="rim"/> <map value="player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code"/> </mapping> <mapping> <identity value="v2"/> <map value="LAN-2"/> </mapping> </definition> </element> <element> <path value="Patient.careProvider"/> <definition> <short value="Patient's nominated care provider"/> <formal value="Patient's nominated care provider."/> <min value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Organization"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="subjectOf.CareEvent.performer.AssignedEntity"/> </mapping> </definition> </element> <element> <path value="Patient.managingOrganization"/> <definition> <short value="Organization that is the custodian of the patient record"/> <formal value="Organization that is the custodian of the patient record."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Organization"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="scoper"/> </mapping> </definition> </element> <element> <path value="Patient.link"/> <definition> <short value="Link to another patient resource that concerns the same actual person"/> <formal value="Link to another patient resource that concerns the same actual person."/> <comments value="There is no assumption that linked patient records have mutual links."/> <min value="0"/> <max value="*"/> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="outboundLink"/> </mapping> </definition> </element> <element> <path value="Patient.link.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Patient.link.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Patient.link.other"/> <definition> <short value="The other patient resource that the link refers to"/> <formal value="The other patient resource that the link refers to."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="id"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-3, MRG-1"/> </mapping> </definition> </element> <element> <path value="Patient.link.type"/> <definition> <short value="replace | refer | seealso - type of link"/> <formal value="The type of link between this patient resource and another patient resource."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="LinkType"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/link-type"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="typeCode"/> </mapping> </definition> </element> <element> <path value="Patient.active"/> <definition> <short value="Whether this patient's record is in active use"/> <formal value="Whether this patient record is in active use."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="statusCode"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="active"/> <type value="token"/> <documentation value="Whether the patient record is active"/> <xpath value="f:Patient/f:active"/> </searchParam> <searchParam> <name value="address"/> <type value="string"/> <documentation value="An address in any kind of address/part of the patient"/> <xpath value="f:Patient/f:address"/> </searchParam> <searchParam> <name value="animal-breed"/> <type value="token"/> <documentation value="The breed for animal patients"/> <xpath value="f:Patient/f:animal/f:breed"/> </searchParam> <searchParam> <name value="animal-species"/> <type value="token"/> <documentation value="The species for animal patients"/> <xpath value="f:Patient/f:animal/f:species"/> </searchParam> <searchParam> <name value="birthdate"/> <type value="date"/> <documentation value="The patient's date of birth"/> <xpath value="f:Patient/f:birthDate"/> </searchParam> <searchParam> <name value="family"/> <type value="string"/> <documentation value="A portion of the family name of the patient"/> <xpath value="f:Patient/f:name/f:family"/> </searchParam> <searchParam> <name value="gender"/> <type value="token"/> <documentation value="Gender of the patient"/> <xpath value="f:Patient/f:gender"/> </searchParam> <searchParam> <name value="given"/> <type value="string"/> <documentation value="A portion of the given name of the patient"/> <xpath value="f:Patient/f:name/f:given"/> </searchParam> <searchParam> <name value="identifier"/> <type value="token"/> <documentation value="A patient identifier"/> <xpath value="f:Patient/f:identifier"/> </searchParam> <searchParam> <name value="language"/> <type value="token"/> <documentation value="Language code (irrespective of use value)"/> <xpath value="f:Patient/f:communication"/> </searchParam> <searchParam> <name value="link"/> <type value="reference"/> <documentation value="All patients linked to the given patient"/> <xpath value="f:Patient/f:link/f:other"/> </searchParam> <searchParam> <name value="name"/> <type value="string"/> <documentation value="A portion of either family or given name of the patient"/> <xpath value="f:Patient/f:name"/> </searchParam> <searchParam> <name value="phonetic"/> <type value="string"/> <documentation value="A portion of either family or given name using some kind of phonetic matching algorithm"/> </searchParam> <searchParam> <name value="provider"/> <type value="reference"/> <documentation value="The organization at which this person is a patient"/> <xpath value="f:Patient/f:managingOrganization"/> </searchParam> <searchParam> <name value="telecom"/> <type value="string"/> <documentation value="The value in any kind of telecom details of the patient"/> <xpath value="f:Patient/f:telecom"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="patient-definitions.html#Patient" title="Demographics and other administrative information about a person or animal receiving care or other health-related services."><b>Patient</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="patient-definitions.html#Patient.identifier" title="An identifier that applies to this person as a patient."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></identifier> <<a class="dict" href="patient-definitions.html#Patient.name" title="A name associated with the individual."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></name> <<a class="dict" href="patient-definitions.html#Patient.telecom" title="A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></telecom> <<a class="dict" href="patient-definitions.html#Patient.gender" title="Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes."><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 href="valueset-administrative-gender.html" style="color: navy">Gender for administrative purposes<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></gender> <<a class="dict" href="patient-definitions.html#Patient.birthDate" title="The date and time of birth for the individual."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="patient-definitions.html#Patient.deceased_x_" title="Indicates if the individual is deceased or not (this element modifies the meaning of other elements)"><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></deceased[x]> <<a class="dict" href="patient-definitions.html#Patient.address" title="Addresses for the individual."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></address> <<a class="dict" href="patient-definitions.html#Patient.maritalStatus" title="This field contains a patient's most recent marital (civil) status."><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 href="valueset-marital-status.html" style="color: navy">Marital (civil) status of a person<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></maritalStatus> <<a class="dict" href="patient-definitions.html#Patient.multipleBirth_x_" title="Indicates whether the patient is part of a multiple or indicates the actual birth order."><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"> Whether patient is part of a multiple birth<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></multipleBirth[x]> <<a class="dict" href="patient-definitions.html#Patient.photo" title="Image of the person."><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> <<a class="dict" href="patient-definitions.html#Patient.contact" title="A contact party (e.g. guardian, partner, friend) for the patient."><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> <<a class="dict" href="patient-definitions.html#Patient.contact.relationship" title="The nature of the relationship between the patient and the contact person."><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 href="valueset-patient-contact-relationship.html" style="color: navy">The kind of relationship</a></span><span style="color: Gray"> --></span></relationship> <<a class="dict" href="patient-definitions.html#Patient.contact.name" title="A name associated with the person."><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> <<a class="dict" href="patient-definitions.html#Patient.contact.telecom" title="A contact detail for the person, e.g. a telephone number or an email address."><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> <<a class="dict" href="patient-definitions.html#Patient.contact.address" title="Address for the contact person."><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> <<a class="dict" href="patient-definitions.html#Patient.contact.gender" title="Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes."><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 href="valueset-administrative-gender.html" style="color: navy">Gender for administrative purposes</a></span><span style="color: Gray"> --></span></gender> <<a class="dict" href="patient-definitions.html#Patient.contact.organization" title="Organization on behalf of which the contact is acting or for which the contact is working."><b>organization</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: SHALL at least contain a contact's details or a reference to an organization"><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"> Organization that is associated with the contact</span><span style="color: Gray"> --></span></organization> </contact> <<a class="dict" href="patient-definitions.html#Patient.animal" title="This element has a value if the patient is an animal (this element modifies the meaning of other elements)"><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span> --></span> <<a class="dict" href="patient-definitions.html#Patient.animal.species" title="Identifies the high level categorization of the kind of animal."><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 href="valueset-animal-species.html" style="color: navy">E.g. Dog, Cow<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></species> <<a class="dict" href="patient-definitions.html#Patient.animal.breed" title="Identifies the detailed categorization of the kind of animal."><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 href="valueset-animal-breeds.html" style="color: navy">E.g. Poodle, Angus<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></breed> <<a class="dict" href="patient-definitions.html#Patient.animal.genderStatus" title="Indicates the current state of the animal's reproductive organs."><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 href="valueset-animal-genderstatus.html" style="color: navy">E.g. Neutered, Intact<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></genderStatus> </animal> <<a class="dict" href="patient-definitions.html#Patient.communication" title="Languages which may be used to communicate with the patient about his or her health."><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 href="http://tools.ietf.org/html/bcp47.html" style="color: navy">Languages which may be used to communicate with the patient about his or her health</a></span><span style="color: Gray"> --></span></communication> <<a class="dict" href="patient-definitions.html#Patient.careProvider" title="Patient's nominated care provider."><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"> Patient's nominated care provider</span><span style="color: Gray"> --></span></careProvider> <<a class="dict" href="patient-definitions.html#Patient.managingOrganization" title="Organization that is the custodian of the patient record."><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"> Organization that is the custodian of the patient record<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></managingOrganization> <<a class="dict" href="patient-definitions.html#Patient.link" title="Link to another patient resource that concerns the same actual person (this element modifies the meaning of other elements)"><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span> --></span> <<a class="dict" href="patient-definitions.html#Patient.link.other" title="The other patient resource that the link refers to (this element modifies the meaning of other elements)"><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></other> <<a class="dict" href="patient-definitions.html#Patient.link.type" title="The type of link between this patient resource and another patient resource (this element modifies the meaning of other elements)"><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 href="link-type.html" style="color: navy">replace | refer | seealso - type of link<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span> </link> <<a class="dict" href="patient-definitions.html#Patient.active" title="Whether this patient record is in active use (this element modifies the meaning of other elements)"><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> </Patient> </pre></div> </summary> </entry> <entry> <title>"practitioner" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/practitioner</id> <link href="http://hl7.org/implement/standards/fhir/practitioner.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="practitioner-definitions.html#Practitioner" title="A person who is directly or indirectly involved in the provisioning of healthcare."><b>Practitioner</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="practitioner-definitions.html#Practitioner.identifier" title="An identifier that applies to this person in this role."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></identifier> <<a class="dict" href="practitioner-definitions.html#Practitioner.name" title="A name associated with the person."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></name> <<a class="dict" href="practitioner-definitions.html#Practitioner.telecom" title="A contact detail for the practitioner, e.g. a telephone number or an email address."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></telecom> <<a class="dict" href="practitioner-definitions.html#Practitioner.address" title="The postal address where the practitioner can be found or visited or to which mail can be delivered."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></address> <<a class="dict" href="practitioner-definitions.html#Practitioner.gender" title="Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes."><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 href="valueset-administrative-gender.html" style="color: navy">Gender for administrative purposes<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></gender> <<a class="dict" href="practitioner-definitions.html#Practitioner.birthDate" title="The date and time of birth for the practitioner."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="practitioner-definitions.html#Practitioner.photo" title="Image of the person."><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> <<a class="dict" href="practitioner-definitions.html#Practitioner.organization" title="The organization that the practitioner represents."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></organization> <<a class="dict" href="practitioner-definitions.html#Practitioner.role" title="Roles which this practitioner is authorized to perform for the organization."><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 href="valueset-practitioner-role.html" style="color: navy">Roles which this practitioner may perform<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></role> <<a class="dict" href="practitioner-definitions.html#Practitioner.specialty" title="Specific specialty of the practitioner."><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 href="valueset-practitioner-specialty.html" style="color: navy">Specific specialty of the practitioner<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></specialty> <<a class="dict" href="practitioner-definitions.html#Practitioner.period" title="The period during which the person is authorized to act as a practitioner in these role(s) for the organization."><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 during which the practitioner is authorized to perform in these role(s)<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></period> <<a class="dict" href="practitioner-definitions.html#Practitioner.location" title="The location(s) at which this practitioner provides care."><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"> The location(s) at which this practitioner provides care</span><span style="color: Gray"> --></span></location> <<a class="dict" href="practitioner-definitions.html#Practitioner.qualification" title="Qualifications obtained by training and certification."><b>qualification</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Qualifications obtained by training and certification --></span> <<a class="dict" href="practitioner-definitions.html#Practitioner.qualification.code" title="Coded representation of the qualification."><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 href="valueset-anzsco-occupations.html" style="color: navy">Coded representation of the qualification</a></span><span style="color: Gray"> --></span></code> <<a class="dict" href="practitioner-definitions.html#Practitioner.qualification.period" title="Period during which the qualification is valid."><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> <<a class="dict" href="practitioner-definitions.html#Practitioner.qualification.issuer" title="Organization that regulates and issues the qualification."><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"> Organization that regulates and issues the qualification</span><span style="color: Gray"> --></span></issuer> </qualification> <<a class="dict" href="practitioner-definitions.html#Practitioner.communication" title="A language the practitioner is able to use in 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 href="http://tools.ietf.org/html/bcp47.html" style="color: navy">A language the practitioner is able to use in patient communication</a></span><span style="color: Gray"> --></span></communication> </Practitioner> </pre></div> </text> <name value="practitioner"/> <publisher value="FHIR Project"/> <description value="Basic Profile. A person who is directly or indirectly involved in the provisioning of healthcare."/> <status value="draft"/> <date value="2014-09-30"/> <requirements value="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): * physicians, dentists, pharmacists * physician assistants, nurses, scribes * midwives, dietitians, therapists, optometrists, paramedics * medical technicians, laboratory scientists, prosthetic technicians, radiographers * social workers, professional home carers, official volunteers * receptionists handling patient registration * IT personnel merging or unmerging patient records"/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <mapping> <identity value="servd"/> <uri value="http://www.omg.org/spec/ServD/1.0/"/> <name value="ServD"/> </mapping> <structure> <type value="Practitioner"/> <publish value="true"/> <element> <path value="Practitioner"/> <definition> <short value="A person with a formal responsibility in the provisioning of healthcare or related services"/> <formal value="A person who is directly or indirectly involved in the provisioning of healthcare."/> <comments value="Note that a cab driver no longer fits the bill. You probably would be interested in the organization rather than the individual?."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Role"/> </mapping> <mapping> <identity value="v2"/> <map value="PRD (as one example)"/> </mapping> <mapping> <identity value="servd"/> <map value="Provider"/> </mapping> </definition> </element> <element> <path value="Practitioner.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Practitioner.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Practitioner.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Practitioner.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Practitioner.identifier"/> <definition> <short value="A identifier for the person as this agent"/> <formal value="An identifier that applies to this person in this role."/> <min value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./id"/> </mapping> <mapping> <identity value="v2"/> <map value="PRD-7 (or XCN.1 Person Identifier)"/> </mapping> <mapping> <identity value="servd"/> <map value="./Identifiers"/> </mapping> </definition> </element> <element> <path value="Practitioner.name"/> <definition> <short value="A name associated with the person"/> <formal value="A name associated with the person."/> <min value="0"/> <max value="1"/> <type> <code value="HumanName"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./name"/> </mapping> <mapping> <identity value="v2"/> <map value="XCN Components"/> </mapping> <mapping> <identity value="servd"/> <map value="./PreferredName (GivenNames, FamilyName, TitleCode)"/> </mapping> </definition> </element> <element> <path value="Practitioner.telecom"/> <definition> <short value="A contact detail for the practitioner"/> <formal value="A contact detail for the practitioner, e.g. a telephone number or an email address."/> <comments value="Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification."/> <min value="0"/> <max value="*"/> <type> <code value="Contact"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./telecom"/> </mapping> <mapping> <identity value="v2"/> <map value="PRT-15, STF-10, ROL-12"/> </mapping> <mapping> <identity value="servd"/> <map value="./ContactPoints"/> </mapping> </definition> </element> <element> <path value="Practitioner.address"/> <definition> <short value="Where practitioner can be found/visited"/> <formal value="The postal address where the practitioner can be found or visited or to which mail can be delivered."/> <min value="0"/> <max value="1"/> <type> <code value="Address"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./addr"/> </mapping> <mapping> <identity value="v2"/> <map value="ORC-24, STF-11, ROL-11, PRT-14"/> </mapping> <mapping> <identity value="servd"/> <map value="./Addresses"/> </mapping> </definition> </element> <element> <path value="Practitioner.gender"/> <definition> <short value="Gender for administrative purposes"/> <formal value="Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="AdministrativeGender"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/administrative-gender"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="./administrativeGender"/> </mapping> <mapping> <identity value="v2"/> <map value="STF-5"/> </mapping> <mapping> <identity value="servd"/> <map value="./GenderCode"/> </mapping> </definition> </element> <element> <path value="Practitioner.birthDate"/> <definition> <short value="The date and time of birth for the practitioner"/> <formal value="The date and time of birth for the practitioner."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./birthTime"/> </mapping> <mapping> <identity value="v2"/> <map value="STF-6"/> </mapping> <mapping> <identity value="servd"/> <map value="(not represented in ServD)"/> </mapping> </definition> </element> <element> <path value="Practitioner.photo"/> <definition> <short value="Image of the person"/> <formal value="Image of the person."/> <min value="0"/> <max value="*"/> <type> <code value="Attachment"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./subjectOf/ObservationEvent[code="photo"]/value"/> </mapping> <mapping> <identity value="servd"/> <map value="./ImageURI (only supports the URI reference)"/> </mapping> </definition> </element> <element> <path value="Practitioner.organization"/> <definition> <short value="The represented organization"/> <formal value="The organization that the practitioner represents."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Organization"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./scoper"/> </mapping> <mapping> <identity value="v2"/> <map value="PRD-10 (-> 14) / PRA-9-Institution / PRT-8-Participation Organization for person participation"/> </mapping> <mapping> <identity value="servd"/> <map value="(ServD maps Practitioners and Organizations via another entity, so this concept is not available)"/> </mapping> </definition> </element> <element> <path value="Practitioner.role"/> <definition> <short value="Roles which this practitioner may perform"/> <formal value="Roles which this practitioner is authorized to perform for the organization."/> <comments value="A person may have more than one role. At least one role is required."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="PractitionerRole"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/practitioner-role"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="./code"/> </mapping> <mapping> <identity value="v2"/> <map value="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"/> </mapping> <mapping> <identity value="servd"/> <map value="(ServD maps Practitioners and Organizations via another entity, so this concept is not available)"/> </mapping> </definition> </element> <element> <path value="Practitioner.specialty"/> <definition> <short value="Specific specialty of the practitioner"/> <formal value="Specific specialty of the practitioner."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="PractitionerSpecialty"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/practitioner-specialty"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="indirectAuthority/QualifiedEntity[code < Speciality]/code"/> </mapping> <mapping> <identity value="v2"/> <map value="PRA-5-specialty"/> </mapping> <mapping> <identity value="servd"/> <map value="./Specialty"/> </mapping> </definition> </element> <element> <path value="Practitioner.period"/> <definition> <short value="The period during which the practitioner is authorized to perform in these role(s)"/> <formal value="The period during which the person is authorized to act as a practitioner in these role(s) for the organization."/> <min value="0"/> <max value="1"/> <type> <code value="Period"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./effectiveTime"/> </mapping> <mapping> <identity value="v2"/> <map value="PRD-8/9 / PRA-5.4-date of certification"/> </mapping> <mapping> <identity value="servd"/> <map value="(ServD maps Practitioners and Organizations via another entity, so this concept is not available)"/> </mapping> </definition> </element> <element> <path value="Practitioner.location"/> <definition> <short value="The location(s) at which this practitioner provides care"/> <formal value="The location(s) at which this practitioner provides care."/> <min value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Location"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./target[classCode="indirectAuthority].source[classCode=SDLOC]"/> </mapping> <mapping> <identity value="servd"/> <map value="(ServD maps Practitioners and Organizations via another entity, so this concept is not available)<br/> However these are accessed via the Site.ServiceSite.ServiceSiteProvider record. (The Site has the location)"/> </mapping> </definition> </element> <element> <path value="Practitioner.qualification"/> <definition> <short value="Qualifications obtained by training and certification"/> <formal value="Qualifications obtained by training and certification."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./indirectAuthority/QualifiedEntity[code < qualifiedEntity]"/> </mapping> <mapping> <identity value="v2"/> <map value="CER?"/> </mapping> <mapping> <identity value="servd"/> <map value="./Qualifications"/> </mapping> </definition> </element> <element> <path value="Practitioner.qualification.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Practitioner.qualification.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Practitioner.qualification.code"/> <definition> <short value="Coded representation of the qualification"/> <formal value="Coded representation of the qualification."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="Qualification"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/anzsco-occupations"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="./code"/> </mapping> <mapping> <identity value="servd"/> <map value="./Qualifications.Value"/> </mapping> </definition> </element> <element> <path value="Practitioner.qualification.period"/> <definition> <short value="Period during which the qualification is valid"/> <formal value="Period during which the qualification is valid."/> <min value="0"/> <max value="1"/> <type> <code value="Period"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./effectiveTime"/> </mapping> <mapping> <identity value="servd"/> <map value="./Qualifications.StartDate and ./Qualifications.EndDate"/> </mapping> </definition> </element> <element> <path value="Practitioner.qualification.issuer"/> <definition> <short value="Organization that regulates and issues the qualification"/> <formal value="Organization that regulates and issues the qualification."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Organization"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./scoper"/> </mapping> </definition> </element> <element> <path value="Practitioner.communication"/> <definition> <short value="A language the practitioner is able to use in patient communication"/> <formal value="A language the practitioner is able to use in patient communication."/> <comments value="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 value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="Language"/> <isExtensible value="false"/> <conformance value="required"/> <referenceUri value="http://tools.ietf.org/html/bcp47"/> </binding> <mapping> <identity value="rim"/> <map value="./languageCode"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-15, NK1-20, LAN-2"/> </mapping> <mapping> <identity value="servd"/> <map value="./Languages.LanguageSpokenCode"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="address"/> <type value="string"/> <documentation value="An address in any kind of address/part"/> <xpath value="f:Practitioner/f:address"/> </searchParam> <searchParam> <name value="family"/> <type value="string"/> <documentation value="A portion of the family name"/> <xpath value="f:Practitioner/f:name"/> </searchParam> <searchParam> <name value="gender"/> <type value="token"/> <documentation value="Gender of the practitioner"/> <xpath value="f:Practitioner/f:gender"/> </searchParam> <searchParam> <name value="given"/> <type value="string"/> <documentation value="A portion of the given name"/> <xpath value="f:Practitioner/f:name"/> </searchParam> <searchParam> <name value="identifier"/> <type value="token"/> <documentation value="A practitioner's Identifier"/> <xpath value="f:Practitioner/f:identifier"/> </searchParam> <searchParam> <name value="name"/> <type value="string"/> <documentation value="A portion of either family or given name"/> <xpath value="f:Practitioner/f:name"/> </searchParam> <searchParam> <name value="organization"/> <type value="reference"/> <documentation value="The identity of the organization the practitioner represents / acts on behalf of"/> <xpath value="f:Practitioner/f:organization"/> </searchParam> <searchParam> <name value="phonetic"/> <type value="string"/> <documentation value="A portion of either family or given name using some kind of phonetic matching algorithm"/> <xpath value="f:Practitioner/f:name"/> </searchParam> <searchParam> <name value="telecom"/> <type value="string"/> <documentation value="The value in any kind of contact"/> <xpath value="f:Practitioner/f:telecom"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="practitioner-definitions.html#Practitioner" title="A person who is directly or indirectly involved in the provisioning of healthcare."><b>Practitioner</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="practitioner-definitions.html#Practitioner.identifier" title="An identifier that applies to this person in this role."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></identifier> <<a class="dict" href="practitioner-definitions.html#Practitioner.name" title="A name associated with the person."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></name> <<a class="dict" href="practitioner-definitions.html#Practitioner.telecom" title="A contact detail for the practitioner, e.g. a telephone number or an email address."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></telecom> <<a class="dict" href="practitioner-definitions.html#Practitioner.address" title="The postal address where the practitioner can be found or visited or to which mail can be delivered."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></address> <<a class="dict" href="practitioner-definitions.html#Practitioner.gender" title="Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes."><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 href="valueset-administrative-gender.html" style="color: navy">Gender for administrative purposes<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></gender> <<a class="dict" href="practitioner-definitions.html#Practitioner.birthDate" title="The date and time of birth for the practitioner."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="practitioner-definitions.html#Practitioner.photo" title="Image of the person."><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> <<a class="dict" href="practitioner-definitions.html#Practitioner.organization" title="The organization that the practitioner represents."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></organization> <<a class="dict" href="practitioner-definitions.html#Practitioner.role" title="Roles which this practitioner is authorized to perform for the organization."><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 href="valueset-practitioner-role.html" style="color: navy">Roles which this practitioner may perform<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></role> <<a class="dict" href="practitioner-definitions.html#Practitioner.specialty" title="Specific specialty of the practitioner."><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 href="valueset-practitioner-specialty.html" style="color: navy">Specific specialty of the practitioner<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></specialty> <<a class="dict" href="practitioner-definitions.html#Practitioner.period" title="The period during which the person is authorized to act as a practitioner in these role(s) for the organization."><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 during which the practitioner is authorized to perform in these role(s)<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></period> <<a class="dict" href="practitioner-definitions.html#Practitioner.location" title="The location(s) at which this practitioner provides care."><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"> The location(s) at which this practitioner provides care</span><span style="color: Gray"> --></span></location> <<a class="dict" href="practitioner-definitions.html#Practitioner.qualification" title="Qualifications obtained by training and certification."><b>qualification</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Qualifications obtained by training and certification --></span> <<a class="dict" href="practitioner-definitions.html#Practitioner.qualification.code" title="Coded representation of the qualification."><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 href="valueset-anzsco-occupations.html" style="color: navy">Coded representation of the qualification</a></span><span style="color: Gray"> --></span></code> <<a class="dict" href="practitioner-definitions.html#Practitioner.qualification.period" title="Period during which the qualification is valid."><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> <<a class="dict" href="practitioner-definitions.html#Practitioner.qualification.issuer" title="Organization that regulates and issues the qualification."><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"> Organization that regulates and issues the qualification</span><span style="color: Gray"> --></span></issuer> </qualification> <<a class="dict" href="practitioner-definitions.html#Practitioner.communication" title="A language the practitioner is able to use in 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 href="http://tools.ietf.org/html/bcp47.html" style="color: navy">A language the practitioner is able to use in patient communication</a></span><span style="color: Gray"> --></span></communication> </Practitioner> </pre></div> </summary> </entry> <entry> <title>"procedure" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/procedure</id> <link href="http://hl7.org/implement/standards/fhir/procedure.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="procedure-definitions.html#Procedure" 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."><b>Procedure</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="procedure-definitions.html#Procedure.identifier" 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)."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></identifier> <<a class="dict" href="procedure-definitions.html#Procedure.subject" title="The person on whom the procedure was performed."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></subject> <<a class="dict" href="procedure-definitions.html#Procedure.type" title="The specific procedure that is performed. Use text if the exact nature of the procedure can't be coded."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></type> <<a class="dict" href="procedure-definitions.html#Procedure.bodySite" title="Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></bodySite> <<a class="dict" href="procedure-definitions.html#Procedure.indication" 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."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></indication> <<a class="dict" href="procedure-definitions.html#Procedure.performer" title="Limited to 'real' people rather than equipment."><b>performer</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> The people who performed the procedure<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span> --></span> <<a class="dict" href="procedure-definitions.html#Procedure.performer.person" title="The practitioner who was involved in the procedure."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></person> <<a class="dict" href="procedure-definitions.html#Procedure.performer.role" title="E.g. surgeon, anaethetist, endoscopist."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></role> </performer> <<a class="dict" href="procedure-definitions.html#Procedure.date" 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."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></date> <<a class="dict" href="procedure-definitions.html#Procedure.encounter" title="The encounter during which the procedure was performed."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></encounter> <<a class="dict" href="procedure-definitions.html#Procedure.outcome" title="What was the outcome of the procedure - did it resolve reasons why the procedure was performed?."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="procedure-definitions.html#Procedure.report" title="This could be a histology result. There could potentially be multiple reports - e.g. if this was a procedure that made multiple biopsies."><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> <<a class="dict" href="procedure-definitions.html#Procedure.complication" 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."><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> <<a class="dict" href="procedure-definitions.html#Procedure.followUp" 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."><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> <<a class="dict" href="procedure-definitions.html#Procedure.relatedItem" title="Procedures may be related to other items such as procedures or medications. For example treating wound dehiscence following a previous procedure."><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> <<a class="dict" href="procedure-definitions.html#Procedure.relatedItem.type" title="The nature of the relationship."><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 href="procedure-relationship-type.html" style="color: navy">caused-by | because-of</a></span><span style="color: Gray"> --></span> <<a class="dict" href="procedure-definitions.html#Procedure.relatedItem.target" title="The related item - e.g. a procedure."><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>| <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>| <a href="imagingstudy.html#ImagingStudy">ImagingStudy</a>|<a href="immunization.html#Immunization">Immunization</a>|<a href="immunizationrecommendation.html#ImmunizationRecommendation">ImmunizationRecommendation</a>| <a href="medicationadministration.html#MedicationAdministration">MedicationAdministration</a>|<a href="medicationdispense.html#MedicationDispense">MedicationDispense</a>|<a href="medicationprescription.html#MedicationPrescription">MedicationPrescription</a>| <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> </relatedItem> <<a class="dict" href="procedure-definitions.html#Procedure.notes" title="Any other notes about the procedure - e.g. the operative 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> </Procedure> </pre></div> </text> <name value="procedure"/> <publisher value="FHIR Project"/> <description value="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 value="draft"/> <date value="2014-09-30"/> <requirements value="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. Note 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 value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <structure> <type value="Procedure"/> <publish value="true"/> <element> <path value="Procedure"/> <definition> <short value="An action that is performed on a patient"/> <formal value="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 value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Procedure[moodCode=EVN]"/> </mapping> </definition> </element> <element> <path value="Procedure.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Procedure.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Procedure.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Procedure.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Procedure.identifier"/> <definition> <short value="External Ids for this procedure"/> <formal value="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 value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> </definition> </element> <element> <path value="Procedure.subject"/> <definition> <short value="Who procedure was performed on"/> <formal value="The person on whom the procedure was performed."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=SBJ].role"/> </mapping> </definition> </element> <element> <path value="Procedure.type"/> <definition> <short value="Identification of the procedure"/> <formal value="The specific procedure that is performed. Use text if the exact nature of the procedure can't be coded."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> </definition> </element> <element> <path value="Procedure.bodySite"/> <definition> <short value="Precise location details"/> <formal value="Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".approachSiteCode"/> </mapping> </definition> </element> <element> <path value="Procedure.indication"/> <definition> <short value="Reason procedure performed"/> <formal value="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 value="e.g. endoscopy for dilatation and biopsy, combination diagnosis and therapuetic."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".reasonCode"/> </mapping> </definition> </element> <element> <path value="Procedure.performer"/> <definition> <short value="The people who performed the procedure"/> <formal value="Limited to 'real' people rather than equipment."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=PFM]"/> </mapping> </definition> </element> <element> <path value="Procedure.performer.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Procedure.performer.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Procedure.performer.person"/> <definition> <short value="The reference to the practitioner"/> <formal value="The practitioner who was involved in the procedure."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".role"/> </mapping> </definition> </element> <element> <path value="Procedure.performer.role"/> <definition> <short value="The role the person was in"/> <formal value="E.g. surgeon, anaethetist, endoscopist."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".functionCode"/> </mapping> </definition> </element> <element> <path value="Procedure.date"/> <definition> <short value="The date the procedure was performed"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="Period"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".effectiveTime"/> </mapping> <mapping> <identity value="v2"/> <map value="This should be choice of dateTime|Period"/> </mapping> </definition> </element> <element> <path value="Procedure.encounter"/> <definition> <short value="The encounter when procedure performed"/> <formal value="The encounter during which the procedure was performed."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Encounter"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"/> </mapping> </definition> </element> <element> <path value="Procedure.outcome"/> <definition> <short value="What was result of procedure?"/> <formal value="What was the outcome of the procedure - did it resolve reasons why the procedure was performed?."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=OUT].target.text"/> </mapping> </definition> </element> <element> <path value="Procedure.report"/> <definition> <short value="Any report that results from the procedure"/> <formal value="This could be a histology result. There could potentially be multiple reports - e.g. if this was a procedure that made multiple biopsies."/> <min value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/DiagnosticReport"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN]"/> </mapping> </definition> </element> <element> <path value="Procedure.complication"/> <definition> <short value="Complication following the procedure"/> <formal value="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 value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Need specialization of OUT for this."/> </mapping> </definition> </element> <element> <path value="Procedure.followUp"/> <definition> <short value="Instructions for follow up"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=COMP].target[classCode=ACT, moodCode=INT].text"/> </mapping> </definition> </element> <element> <path value="Procedure.relatedItem"/> <definition> <short value="A procedure that is related to this one"/> <formal value="Procedures may be related to other items such as procedures or medications. For example treating wound dehiscence following a previous procedure."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=TRIG and target[classCode=PROC, moodCode=EVN]]"/> </mapping> </definition> </element> <element> <path value="Procedure.relatedItem.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Procedure.relatedItem.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Procedure.relatedItem.type"/> <definition> <short value="caused-by | because-of"/> <formal value="The nature of the relationship."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="ProcedureRelationshipType"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/procedure-relationship-type"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".inversionInd"/> </mapping> </definition> </element> <element> <path value="Procedure.relatedItem.target"/> <definition> <short value="The related item - e.g. a procedure"/> <formal value="The related item - e.g. a procedure."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/AdverseReaction"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/AllergyIntolerance"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/CarePlan"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Condition"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/DeviceObservationReport"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/DiagnosticReport"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/FamilyHistory"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/ImagingStudy"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Immunization"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/ImmunizationRecommendation"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/MedicationAdministration"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/MedicationDispense"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/MedicationPrescription"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/MedicationStatement"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Observation"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Procedure"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".target"/> </mapping> </definition> </element> <element> <path value="Procedure.notes"/> <definition> <short value="Additional information about procedure"/> <formal value="Any other notes about the procedure - e.g. the operative notes."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="annotation"] .value"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="date"/> <type value="date"/> <documentation value="The date the procedure was performed on"/> <xpath value="f:Procedure/f:date"/> </searchParam> <searchParam> <name value="subject"/> <type value="reference"/> <documentation value="The identity of a patient to list procedures for"/> <xpath value="f:Procedure/f:subject"/> </searchParam> <searchParam> <name value="type"/> <type value="token"/> <documentation value="Type of procedure"/> <xpath value="f:Procedure/f:type"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="procedure-definitions.html#Procedure" 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."><b>Procedure</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="procedure-definitions.html#Procedure.identifier" 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)."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></identifier> <<a class="dict" href="procedure-definitions.html#Procedure.subject" title="The person on whom the procedure was performed."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></subject> <<a class="dict" href="procedure-definitions.html#Procedure.type" title="The specific procedure that is performed. Use text if the exact nature of the procedure can't be coded."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></type> <<a class="dict" href="procedure-definitions.html#Procedure.bodySite" title="Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></bodySite> <<a class="dict" href="procedure-definitions.html#Procedure.indication" 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."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></indication> <<a class="dict" href="procedure-definitions.html#Procedure.performer" title="Limited to 'real' people rather than equipment."><b>performer</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> The people who performed the procedure<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span> --></span> <<a class="dict" href="procedure-definitions.html#Procedure.performer.person" title="The practitioner who was involved in the procedure."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></person> <<a class="dict" href="procedure-definitions.html#Procedure.performer.role" title="E.g. surgeon, anaethetist, endoscopist."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></role> </performer> <<a class="dict" href="procedure-definitions.html#Procedure.date" 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."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></date> <<a class="dict" href="procedure-definitions.html#Procedure.encounter" title="The encounter during which the procedure was performed."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></encounter> <<a class="dict" href="procedure-definitions.html#Procedure.outcome" title="What was the outcome of the procedure - did it resolve reasons why the procedure was performed?."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="procedure-definitions.html#Procedure.report" title="This could be a histology result. There could potentially be multiple reports - e.g. if this was a procedure that made multiple biopsies."><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> <<a class="dict" href="procedure-definitions.html#Procedure.complication" 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."><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> <<a class="dict" href="procedure-definitions.html#Procedure.followUp" 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."><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> <<a class="dict" href="procedure-definitions.html#Procedure.relatedItem" title="Procedures may be related to other items such as procedures or medications. For example treating wound dehiscence following a previous procedure."><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> <<a class="dict" href="procedure-definitions.html#Procedure.relatedItem.type" title="The nature of the relationship."><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 href="procedure-relationship-type.html" style="color: navy">caused-by | because-of</a></span><span style="color: Gray"> --></span> <<a class="dict" href="procedure-definitions.html#Procedure.relatedItem.target" title="The related item - e.g. a procedure."><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>| <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>| <a href="imagingstudy.html#ImagingStudy">ImagingStudy</a>|<a href="immunization.html#Immunization">Immunization</a>|<a href="immunizationrecommendation.html#ImmunizationRecommendation">ImmunizationRecommendation</a>| <a href="medicationadministration.html#MedicationAdministration">MedicationAdministration</a>|<a href="medicationdispense.html#MedicationDispense">MedicationDispense</a>|<a href="medicationprescription.html#MedicationPrescription">MedicationPrescription</a>| <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> </relatedItem> <<a class="dict" href="procedure-definitions.html#Procedure.notes" title="Any other notes about the procedure - e.g. the operative 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> </Procedure> </pre></div> </summary> </entry> <entry> <title>"profile" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/profile</id> <link href="http://hl7.org/implement/standards/fhir/profile.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="profile-definitions.html#Profile" 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."><b>Profile</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="profile-definitions.html#Profile.identifier" 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)."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.version" 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."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.name" title="A free text natural language name identifying the Profile."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.publisher" title="Details of the individual or organization who accepts responsibility for publishing the profile."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.telecom" title="Contact details to assist a user in finding and communicating with the publisher."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></telecom> <<a class="dict" href="profile-definitions.html#Profile.description" title="A free text natural language description of the profile and its use."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.code" title="A set of terms from external terminologies that may be used to assist with indexing and searching of templates."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></code> <<a class="dict" href="profile-definitions.html#Profile.status" title="The status of the profile (this element modifies the meaning of other elements)"><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 href="resource-profile-status.html" style="color: navy">draft | active | retired<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.experimental" title="This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.date" title="The date that this version of the profile was published."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.requirements" title="The Scope and Usage that this profile was created to meet."><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> <<a class="dict" href="profile-definitions.html#Profile.fhirVersion" title="The version of the FHIR specification on which this profile is based."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.mapping" title="An external specification that the content is mapped to."><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> <<a class="dict" href="profile-definitions.html#Profile.mapping.identity" title="An Internal id that is used to identify this mapping set when specific mappings are made."><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> <<a class="dict" href="profile-definitions.html#Profile.mapping.uri" title="A URI that identifies the specification that this mapping is expressed to."><b>uri</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#uri">uri</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-26: Must have at a name or a uri (or both)"><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> <<a class="dict" href="profile-definitions.html#Profile.mapping.name" title="A name for the specification that is being mapped to."><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" title="Inv-26: Must have at a name or a uri (or both)"><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> <<a class="dict" href="profile-definitions.html#Profile.mapping.comments" title="Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage."><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> </mapping> <<a class="dict" href="profile-definitions.html#Profile.structure" title="A constraint statement about what contents a resource or data type may have."><b>structure</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-8: SHALL define at least one structure constraint or extension definition"><b><img alt="??" src="lock.png"/> 0..*</b></span> A constraint on a resource or a data type --></span> <<a class="dict" href="profile-definitions.html#Profile.structure.type" title="The Resource or Data type being described."><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" title="Inv-12: Only complex types can be constrained, not primitive types such as string etc."><b><img alt="??" src="lock.png"/> 1..1</b></span> <span style="color: navy"><a href="defined-types.html" style="color: navy">The Resource or Data Type being described</a></span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.structure.name" title="The name of this resource constraint statement (to refer to it from other resource constraints - from Profile.structure.element.definition.type.profile)."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.publish" 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."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.purpose" title="Human summary: why describe this resource?."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element" title="Captures constraints on each element within the resource."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.path" title="The path identifies the element and is expressed as a "."-separated list of ancestor elements, beginning with the name of the resource."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.representation" title="Codes that define how this element is represented in instances, when the deviation varies from the normal case."><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 href="property-representation.html" style="color: navy">How this element is represented in instances</a></span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.structure.element.name" 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."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.slicing" 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)."><b>slicing</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..1</b></span> This element is sliced - slices follow --></span> <<a class="dict" href="profile-definitions.html#Profile.structure.element.slicing.discriminator" 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."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.slicing.ordered" title="If the matching elements have to occur in the same order as defined in the profile."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.slicing.rules" 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."><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 href="resource-slicing-rules.html" style="color: navy">closed | open | openAtEnd</a></span><span style="color: Gray"> --></span> </slicing> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition" title="Definition of the content of the element to provide a more specific definition than that contained for the element in the base resource."><b>definition</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..1</b></span> More specific definition of the element --></span> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.short" title="A concise definition that is shown in the generated XML format that summarizes profiles (used throughout the specification)."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.formal" 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."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.comments" title="Comments about the use of the element, including notes about how to use the data properly, exceptions to proper use, etc."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.requirements" title="Explains why this element is needed and why it's been constrained as it has."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.synonym" title="Identifies additional names by which this element might also be known."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.min" title="The minimum number of times this element SHALL appear in the instance."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.max" title="The maximum number of times this element is permitted to appear in the instance."><b>max</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-6: Max SHALL be a number or "*""><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.type" title="The data type or resource that the value of this element is permitted to be."><b>type</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Data type and Profile for this element --></span> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.type.code" title="Name of Data type or Resource."><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 href="data-types.html" style="color: navy">Name of Data type or Resource</a></span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.type.profile" 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."><b>profile</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#uri">uri</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-8: SHALL define at least one structure constraint or extension definition"><b><img alt="??" src="lock.png"/> 0..1</b></span> <span style="color: navy">Profile.structure to apply</span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.type.aggregation" 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."><b>aggregation</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#code">code</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-9: Aggregation may only be specified if one of the allowed types for the element is a resource"><b><img alt="??" src="lock.png"/> 0..*</b></span> <span style="color: navy"><a href="resource-aggregation-mode.html" style="color: navy">contained | referenced | bundled - how aggregated</a></span><span style="color: Gray"> --></span> </type> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.nameReference" title="Identifies the name of a slice defined elsewhere in the profile whose constraints should be applied to the current element."><b>nameReference</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-2: Either a namereference or a fixed value (but not both) is permitted"><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.value_x_" title="Specifies a primitive value that SHALL hold for this element in the instance."><b>value[x]</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" 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."><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]> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.example_x_" title="An example value for this element."><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]> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.maxLength" title="Indicates the shortest length that SHALL be supported by conformant instances without truncation."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.condition" title="A reference to an invariant that may make additional statements about the cardinality or value in the instance."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.constraint" title="Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance."><b>constraint</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Condition that must evaluate to true --></span> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.constraint.key" title="Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.constraint.name" title="Used to label the constraint in OCL or in short displays incapable of displaying the full human description."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.constraint.severity" title="Identifies the impact constraint violation has on the conformance of the instance."><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 href="constraint-severity.html" style="color: navy">error | warning</a></span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.constraint.human" title="Text that can be used to describe the constraint in messages identifying that the constraint has been violated."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.constraint.xpath" title="XPath expression of constraint."><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> </constraint> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.mustSupport" 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."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.isModifier" 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."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.binding" title="Binds to a value set if this element is coded (code, Coding, CodeableConcept)."><b>binding</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-12: Only complex types can be constrained, not primitive types such as string etc."><b><img alt="??" src="lock.png"/> 0..1</b></span> ValueSet details if this is coded --></span> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.binding.name" title="A descriptive name for this - can be useful for generating implementation artifacts."><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" title="Inv-11: Must have either a slice or a definition, but not both"><b><img alt="??" src="lock.png"/> 1..1</b></span> <span style="color: navy">Descriptive Name</span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.binding.isExtensible" 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."><b>isExtensible</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#boolean">boolean</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-14: Example value sets are always extensible"><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.binding.conformance" title="Indicates the degree of conformance expectations associated with this binding."><b>conformance</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#code">code</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-14: Example value sets are always extensible"><b><img alt="??" src="lock.png"/> 0..1</b></span> <span style="color: navy"><a href="binding-conformance.html" style="color: navy">required | preferred | example</a></span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.binding.description" title="Describes the intended use of this particular set of codes."><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" title="Inv-3: provide either a reference or a description (or both)"><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.binding.reference_x_" title="Points to the value set or external definition that identifies the set of codes to be used."><b>reference[x]</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-3: provide either a reference or a description (or both)"><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]> </binding> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.mapping" title="Identifies a concept from an external specification that roughly corresponds to this element."><b>mapping</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Map element to another set of definitions --></span> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.mapping.identity" title="An internal reference to the definition of a mapping."><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" title="Inv-26: Must have at a name or a uri (or both)"><b><img alt="??" src="lock.png"/> 1..1</b></span> <span style="color: navy">Reference to mapping declaration</span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.mapping.map" title="Expresses what part of the target specification corresponds to this element."><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> </mapping> </definition> </element> <<a class="dict" href="profile-definitions.html#Profile.structure.searchParam" title="Additional search parameters for implementations to support and/or make use of."><b>searchParam</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Search params defined --></span> <<a class="dict" href="profile-definitions.html#Profile.structure.searchParam.name" title="The name of the standard or custom search parameter."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.searchParam.type" title="The type of value a search parameter refers to, and how the content is interpreted."><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 href="search-param-type.html" style="color: navy">number | date | string | token | reference | composite | quantity</a></span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.structure.searchParam.documentation" 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."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.searchParam.xpath" title="An XPath expression that returns a set of elements for the search parameter."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.searchParam.target" title="Types of resource (if a resource is referenced)."><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 href="resource-types.html" style="color: navy">Types of resource (if a resource reference)</a></span><span style="color: Gray"> --></span> </searchParam> </structure> <<a class="dict" href="profile-definitions.html#Profile.extensionDefn" title="An extension defined as part of the profile."><b>extensionDefn</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-8: SHALL define at least one structure constraint or extension definition"><b><img alt="??" src="lock.png"/> 0..*</b></span> Definition of an extension --></span> <<a class="dict" href="profile-definitions.html#Profile.extensionDefn.code" title="A unique code (within the profile) used to identify the extension."><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" title="Inv-5: Codes SHALL be unique in the context of a profile"><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> <<a class="dict" href="profile-definitions.html#Profile.extensionDefn.display" title="Defined so that applications can use this name when displaying the value of the extension to the user."><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> <<a class="dict" href="profile-definitions.html#Profile.extensionDefn.contextType" title="Identifies the type of context to which the extension applies."><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 href="extension-context.html" style="color: navy">resource | datatype | mapping | extension</a></span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.extensionDefn.context" title="Identifies the types of resource or data type elements to which the extension can be applied."><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> <<a class="dict" href="profile-definitions.html#Profile.extensionDefn.definition" title="Definition of the extension and its content."><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> </extensionDefn> <<a class="dict" href="profile-definitions.html#Profile.query" title="Definition of a named query and its parameters and their meaning."><b>query</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Definition of a named query --></span> <<a class="dict" href="profile-definitions.html#Profile.query.name" 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."><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> <<a class="dict" href="profile-definitions.html#Profile.query.documentation" title="Description of the query - the functionality it offers, and considerations about how it functions and to use it."><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> <<a class="dict" href="profile-definitions.html#Profile.query.parameter" title="A parameter of a named query."><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> </query> </Profile> </pre></div> </text> <name value="profile"/> <publisher value="FHIR Project"/> <description value="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 value="draft"/> <date value="2014-09-30"/> <requirements value="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. Profile resources have three main parts: * A metadata section the describes the profile, and supports registry searching * Structures that define and describe how a Resource or Data Type is used * Extension Definitions that define extensions that can be used in structures This 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. A 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 value="Profile"/> <publish value="true"/> <element> <path value="Profile"/> <definition> <short value="Resource Profile"/> <formal value="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 value="Often called a clinical template."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <constraint> <key value="17"/> <severity value="error"/> <human value="There can't be multiple structures with the same type and name"/> <xpath value="not(exists(for $structure in f:structure return $structure/preceding-sibling::f:structure[f:type/@va lue=$structure/f:type/@value and f:name/@value = $structure/f:name/@value]))"/> </constraint> <constraint> <key value="15"/> <severity value="error"/> <human value="Where multiple structures exist with the same type, they SHALL have names"/> <xpath value="count(f:structure[not(f:name)]) = count(distinct-values(f:structure[not(f:name)]/f:type/@value))"/> </constraint> <constraint> <key value="8"/> <severity value="error"/> <human value="SHALL define at least one structure constraint or extension definition"/> <xpath value="exists(f:structure) or exists(f:extensionDefn)"/> </constraint> <constraint> <key value="16"/> <severity value="error"/> <human value="Extension definition codes must be unique"/> <xpath value="count(f:extensionDefn) = count(distinct-values(f:extensionDefn/f:code/@value))"/> </constraint> <constraint> <key value="27"/> <severity value="error"/> <human value="Structure name must be unique"/> <xpath value="count(distinct-values(f:structure/f:name/@value)) =count(f:structure/f:name)"/> </constraint> <constraint> <key value="28"/> <severity value="error"/> <human value="Query name must be unique"/> <xpath value="count(distinct-values(f:query/f:name/@value)) =count(f:query/f:name)"/> </constraint> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.identifier"/> <definition> <short value="Logical id to reference this profile"/> <formal value="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 value="N/A."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.version"/> <definition> <short value="Logical id for this version of the profile"/> <formal value="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 value="N/A."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.name"/> <definition> <short value="Informal name for this profile"/> <formal value="A free text natural language name identifying the Profile."/> <comments value="Not expected to be globally unique."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.publisher"/> <definition> <short value="Name of the publisher (Organization or individual)"/> <formal value="Details of the individual or organization who accepts responsibility for publishing the profile."/> <comments value="Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.telecom"/> <definition> <short value="Contact information of the publisher"/> <formal value="Contact details to assist a user in finding and communicating with the publisher."/> <comments value="May be a web site, an email address, a telephone number (tel:), etc."/> <min value="0"/> <max value="*"/> <type> <code value="Contact"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.description"/> <definition> <short value="Natural language description of the profile"/> <formal value="A free text natural language description of the profile and its use."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.code"/> <definition> <short value="Assist with indexing and finding"/> <formal value="A set of terms from external terminologies that may be used to assist with indexing and searching of templates."/> <min value="0"/> <max value="*"/> <type> <code value="Coding"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.status"/> <definition> <short value="draft | active | retired"/> <formal value="The status of the profile."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="ResourceProfileStatus"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/resource-profile-status"/> </referenceResource> </binding> </definition> </element> <element> <path value="Profile.experimental"/> <definition> <short value="If for testing purposes, not real usage"/> <formal value="This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage."/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.date"/> <definition> <short value="Date for this version of the profile"/> <formal value="The date that this version of the profile was published."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.requirements"/> <definition> <short value="Scope and Usage this profile is for"/> <formal value="The Scope and Usage that this profile was created to meet."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.fhirVersion"/> <definition> <short value="FHIR Version this profile targets"/> <formal value="The version of the FHIR specification on which this profile is based."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="id"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.mapping"/> <definition> <short value="External specification that the content is mapped to"/> <formal value="An external specification that the content is mapped to."/> <min value="0"/> <max value="*"/> <constraint> <key value="26"/> <severity value="error"/> <human value="Must have at a name or a uri (or both)"/> <xpath value="exists(f:uri) or exists(f:name)"/> </constraint> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.mapping.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.mapping.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.mapping.identity"/> <definition> <short value="Internal id when this mapping is used"/> <formal value="An Internal id that is used to identify this mapping set when specific mappings are made."/> <comments value="The specification is described once, with general comments, and then specific mappings are made that reference this declaration."/> <min value="1"/> <max value="1"/> <type> <code value="id"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.mapping.uri"/> <definition> <short value="Identifies what this mapping refers to"/> <formal value="A URI that identifies the specification that this mapping is expressed to."/> <comments value="A formal identity for the specification being mapped to helps with identifying maps consistently."/> <min value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.mapping.name"/> <definition> <short value="Names what this mapping refers to"/> <formal value="A name for the specification that is being mapped to."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.mapping.comments"/> <definition> <short value="Versions, Issues, Scope limitations etc"/> <formal value="Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure"/> <definition> <short value="A constraint on a resource or a data type"/> <formal value="A constraint statement about what contents a resource or data type may have."/> <min value="0"/> <max value="*"/> <constraint> <key value="18"/> <severity value="error"/> <human value="Element paths must be unique - or not (LM)"/> <xpath value="count(f:element) >= count(distinct-values(f:element/f:path/@value))"/> </constraint> <constraint> <key value="29"/> <severity value="error"/> <human value="Parameter names must be unique within structure"/> <xpath value="count(distinct-values(f:searchParam/f:name/@value)) =count(f:searchParam/f:name)"/> </constraint> <constraint> <key value="12"/> <severity value="error"/> <human value="Only complex types can be constrained, not primitive types such as string etc."/> <xpath value="upper-case(substring(f:type,1,1))=substring(f:type,1,1)"/> </constraint> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.type"/> <definition> <short value="The Resource or Data Type being described"/> <formal value="The Resource or Data type being described."/> <comments value="Only complex types can be constrained, not primitive types such as string etc."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="FHIRDefinedType"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/defined-types"/> </referenceResource> </binding> </definition> </element> <element> <path value="Profile.structure.name"/> <definition> <short value="Name for this particular structure (reference target)"/> <formal value="The name of this resource constraint statement (to refer to it from other resource constraints - from Profile.structure.element.definition.type.profile)."/> <comments value="This field is the target for a resource.profile."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.publish"/> <definition> <short value="This definition is published (i.e. for validation)"/> <formal value="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 value="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 value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.purpose"/> <definition> <short value="Human summary: why describe this resource?"/> <formal value="Human summary: why describe this resource?."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element"/> <definition> <short value="Definition of elements in the resource (if no profile)"/> <formal value="Captures constraints on each element within the resource."/> <min value="0"/> <max value="*"/> <constraint> <key value="21"/> <severity value="error"/> <human value="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 value="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)"/> </constraint> <constraint> <key value="20"/> <severity value="error"/> <human value="An element must either be a definition or a slicing descriptor, never both."/> <xpath value="exists(f:slicing)!=exists(f:definition)"/> </constraint> <constraint> <key value="11"/> <severity value="error"/> <human value="Must have either a slice or a definition, but not both"/> <xpath value="exists(f:slicing) != exists(f:definition)"/> </constraint> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.path"/> <definition> <short value="The path of the element (see the formal definitions)"/> <formal value="The path identifies the element and is expressed as a "."-separated list of ancestor elements, beginning with the name of the resource."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.representation"/> <definition> <short value="How this element is represented in instances"/> <formal value="Codes that define how this element is represented in instances, when the deviation varies from the normal case."/> <comments value="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 value="0"/> <max value="*"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="PropertyRepresentation"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/property-representation"/> </referenceResource> </binding> </definition> </element> <element> <path value="Profile.structure.element.name"/> <definition> <short value="Name for this particular element definition (reference target)"/> <formal value="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 value="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 value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.slicing"/> <definition> <short value="This element is sliced - slices follow"/> <formal value="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 value="0"/> <max value="1"/> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.slicing.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.slicing.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.slicing.discriminator"/> <definition> <short value="Element that used to distinguish the slices"/> <formal value="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 value="1"/> <max value="1"/> <type> <code value="id"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.slicing.ordered"/> <definition> <short value="If elements must be in same order as slices"/> <formal value="If the matching elements have to occur in the same order as defined in the profile."/> <comments value="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 value="1"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.slicing.rules"/> <definition> <short value="closed | open | openAtEnd"/> <formal value="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 value="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 value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="SlicingRules"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/resource-slicing-rules"/> </referenceResource> </binding> </definition> </element> <element> <path value="Profile.structure.element.definition"/> <definition> <short value="More specific definition of the element"/> <formal value="Definition of the content of the element to provide a more specific definition than that contained for the element in the base resource."/> <comments value="The definition SHALL be a proper constraint on the definition of the base resource."/> <min value="0"/> <max value="1"/> <constraint> <key value="2"/> <severity value="error"/> <human value="Either a namereference or a fixed value (but not both) is permitted"/> <xpath value="not(exists(f:nameReference) and exists(f:*[starts-with(local-name(.), 'value')]))"/> </constraint> <constraint> <key value="10"/> <severity value="error"/> <human value="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 value="not(exists(f:*[starts-with(local-name(.), 'value')])) or (count(f:type)=1 and f:type/f:code[substrin g(@value,1,1)=lower-case(substring(@value,1,1))])"/> </constraint> <constraint> <key value="7"/> <severity value="error"/> <human value="Binding can only be present for coded elements"/> <xpath value="not(exists(f:binding)) or f:type/f:code/@value=('code','Coding','CodeableConcept','Quantity')"/> </constraint> <constraint> <key value="19"/> <severity value="error"/> <human value="Element names must be unique"/> <xpath value="count(f:element[f:name]) = count(distinct-values(f:element/f:name/@value))"/> </constraint> <constraint> <key value="22"/> <severity value="error"/> <human value="If a definition has multiple types with the same code, each must specify a profile"/> <xpath value="count(f:type[not(f:profile)]) = count(distinct-values(f:type[not(f:profile)]/f:code/@value))"/> </constraint> <constraint> <key value="23"/> <severity value="error"/> <human value="Types must be unique by the combination of code and profile"/> <xpath value="not(exists(for $type in f:type return $type/preceding-sibling::f:type[f:code/@value=$type/f:code/@va lue and f:profile/@value = $type/f:profile/@value]))"/> </constraint> <constraint> <key value="24"/> <severity value="error"/> <human value="Constraints must be unique by key"/> <xpath value="count(f:constraint) = count(distinct-values(f:constraint/f:key/@value))"/> </constraint> <constraint> <key value="25"/> <severity value="error"/> <human value="Constraint names must be unique."/> <xpath value="count(f:constraint[f:name]) = count(distinct-values(f:constraint/f:name/@value))"/> </constraint> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.short"/> <definition> <short value="Concise definition for xml presentation"/> <formal value="A concise definition that is shown in the generated XML format that summarizes profiles (used throughout the specification)."/> <comments value="May change the term to provide language more appropriate to the context of the profile or to reflect slicing."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.formal"/> <definition> <short value="Full formal definition in human language"/> <formal value="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 value="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 value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.comments"/> <definition> <short value="Comments about the use of this element"/> <formal value="Comments about the use of the element, including notes about how to use the data properly, exceptions to proper use, etc."/> <comments value="If it is possible to capture usage rules using invariants, that mechanism should be used in preference to this element."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.requirements"/> <definition> <short value="Why is this needed?"/> <formal value="Explains why this element is needed and why it's been constrained as it has."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.synonym"/> <definition> <short value="Other names"/> <formal value="Identifies additional names by which this element might also be known."/> <min value="0"/> <max value="*"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.min"/> <definition> <short value="Minimum Cardinality"/> <formal value="The minimum number of times this element SHALL appear in the instance."/> <min value="1"/> <max value="1"/> <type> <code value="integer"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.max"/> <definition> <short value="Maximum Cardinality (a number or *)"/> <formal value="The maximum number of times this element is permitted to appear in the instance."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <constraint> <key value="6"/> <severity value="error"/> <human value="Max SHALL be a number or "*""/> <xpath value="@value='*' or (normalize-space(@value)!='' and normalize-space(translate(@value, '0123456789',''))=' ')"/> </constraint> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.type"/> <definition> <short value="Data type and Profile for this element"/> <formal value="The data type or resource that the value of this element is permitted to be."/> <comments value="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 value="0"/> <max value="*"/> <constraint> <key value="9"/> <severity value="error"/> <human value="Aggregation may only be specified if one of the allowed types for the element is a resource"/> <xpath value="not(exists(f:aggregation)) or exists(f:code[starts-with(@value, 'Resource(')])"/> </constraint> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.type.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.type.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.type.code"/> <definition> <short value="Name of Data type or Resource"/> <formal value="Name of Data type or Resource."/> <comments value="If the element is a reference to another resource, this element contains "ResourceReference&quo t;, 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 value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="DataType"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/data-types"/> </referenceResource> </binding> </definition> </element> <element> <path value="Profile.structure.element.definition.type.profile"/> <definition> <short value="Profile.structure to apply"/> <formal value="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 value="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 value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.type.aggregation"/> <definition> <short value="contained | referenced | bundled - how aggregated"/> <formal value="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 value="0"/> <max value="*"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="AggregationMode"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/resource-aggregation-mode"/> </referenceResource> </binding> </definition> </element> <element> <path value="Profile.structure.element.definition.nameReference"/> <definition> <short value="To another element constraint (by element.name)"/> <formal value="Identifies the name of a slice defined elsewhere in the profile whose constraints should be applied to the current element."/> <comments value="If child components of this element are defined, they act as constraints on the referenced slice."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.value[x]"/> <definition> <short value="Fixed value: [as defined for a primitive type]"/> <formal value="Specifies a primitive value that SHALL hold for this element in the instance."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="*"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.example[x]"/> <definition> <short value="Example value: [as defined for type]"/> <formal value="An example value for this element."/> <comments value="If the example value are fully populated, the publication tool can generate an instance automatically."/> <min value="0"/> <max value="1"/> <type> <code value="*"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.maxLength"/> <definition> <short value="Length for strings"/> <formal value="Indicates the shortest length that SHALL be supported by conformant instances without truncation."/> <comments value="If not specified, there is no conformance expectation for length support."/> <min value="0"/> <max value="1"/> <type> <code value="integer"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.condition"/> <definition> <short value="Reference to invariant about presence"/> <formal value="A reference to an invariant that may make additional statements about the cardinality or value in the instance."/> <min value="0"/> <max value="*"/> <type> <code value="id"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.constraint"/> <definition> <short value="Condition that must evaluate to true"/> <formal value="Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance."/> <comments value="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 value="0"/> <max value="*"/> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.constraint.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.constraint.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.constraint.key"/> <definition> <short value="Target of 'condition' reference above"/> <formal value="Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality."/> <min value="1"/> <max value="1"/> <type> <code value="id"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.constraint.name"/> <definition> <short value="Short human label"/> <formal value="Used to label the constraint in OCL or in short displays incapable of displaying the full human description."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.constraint.severity"/> <definition> <short value="error | warning"/> <formal value="Identifies the impact constraint violation has on the conformance of the instance."/> <comments value="This allows constraints to be asserted as "shall" (error) and "should" (warning)."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="ConstraintSeverity"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/constraint-severity"/> </referenceResource> </binding> </definition> </element> <element> <path value="Profile.structure.element.definition.constraint.human"/> <definition> <short value="Human description of constraint"/> <formal value="Text that can be used to describe the constraint in messages identifying that the constraint has been violated."/> <comments value="Should be expressed in business terms as much as possible."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.constraint.xpath"/> <definition> <short value="XPath expression of constraint"/> <formal value="XPath expression of constraint."/> <comments value="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 value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.mustSupport"/> <definition> <short value="If the element must supported"/> <formal value="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 value=""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 value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.isModifier"/> <definition> <short value="If this modifies the meaning of other elements"/> <formal value="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 value="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 value="1"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.binding"/> <definition> <short value="ValueSet details if this is coded"/> <formal value="Binds to a value set if this element is coded (code, Coding, CodeableConcept)."/> <min value="0"/> <max value="1"/> <constraint> <key value="3"/> <severity value="error"/> <human value="provide either a reference or a description (or both)"/> <xpath value="(exists(f:referenceUri) or exists(f:referenceResource)) or exists(f:description)"/> </constraint> <constraint> <key value="14"/> <severity value="error"/> <human value="Example value sets are always extensible"/> <xpath value="not(f:Conformance/value='example' and f:isExtensible.value='false')"/> </constraint> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.binding.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.binding.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.binding.name"/> <definition> <short value="Descriptive Name"/> <formal value="A descriptive name for this - can be useful for generating implementation artifacts."/> <comments value="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 value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.binding.isExtensible"/> <definition> <short value="Can additional codes be used?"/> <formal value="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 value="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 value="1"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.binding.conformance"/> <definition> <short value="required | preferred | example"/> <formal value="Indicates the degree of conformance expectations associated with this binding."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="BindingConformance"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/binding-conformance"/> </referenceResource> </binding> </definition> </element> <element> <path value="Profile.structure.element.definition.binding.description"/> <definition> <short value="Human explanation of the value set"/> <formal value="Describes the intended use of this particular set of codes."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.binding.reference[x]"/> <definition> <short value="Source of value set"/> <formal value="Points to the value set or external definition that identifies the set of codes to be used."/> <comments value="For value sets,the referenceResource, the display can contain the value set description. The reference may be version-specific or not."/> <min value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/ValueSet"/> </type> <constraint> <key value="13"/> <severity value="error"/> <human value="uri SHALL start with http:// or https://"/> <xpath value="starts-with(@value, 'http:') or starts-with(@value, 'https:')"/> </constraint> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.mapping"/> <definition> <short value="Map element to another set of definitions"/> <formal value="Identifies a concept from an external specification that roughly corresponds to this element."/> <comments value="Mappings are not necessarily specific enough for safe translation."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.mapping.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.mapping.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.mapping.identity"/> <definition> <short value="Reference to mapping declaration"/> <formal value="An internal reference to the definition of a mapping."/> <min value="1"/> <max value="1"/> <type> <code value="id"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.element.definition.mapping.map"/> <definition> <short value="Details of the mapping"/> <formal value="Expresses what part of the target specification corresponds to this element."/> <comments value="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 value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.searchParam"/> <definition> <short value="Search params defined"/> <formal value="Additional search parameters for implementations to support and/or make use of."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.searchParam.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.searchParam.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.searchParam.name"/> <definition> <short value="Name of search parameter"/> <formal value="The name of the standard or custom search parameter."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.searchParam.type"/> <definition> <short value="number | date | string | token | reference | composite | quantity"/> <formal value="The type of value a search parameter refers to, and how the content is interpreted."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="SearchParamType"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/search-param-type"/> </referenceResource> </binding> </definition> </element> <element> <path value="Profile.structure.searchParam.documentation"/> <definition> <short value="Contents and meaning of search parameter"/> <formal value="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 value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.searchParam.xpath"/> <definition> <short value="XPath that extracts the parameter set"/> <formal value="An XPath expression that returns a set of elements for the search parameter."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.structure.searchParam.target"/> <definition> <short value="Types of resource (if a resource reference)"/> <formal value="Types of resource (if a resource is referenced)."/> <min value="0"/> <max value="*"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="ResourceType"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/resource-types"/> </referenceResource> </binding> </definition> </element> <element> <path value="Profile.extensionDefn"/> <definition> <short value="Definition of an extension"/> <formal value="An extension defined as part of the profile."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.extensionDefn.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.extensionDefn.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.extensionDefn.code"/> <definition> <short value="Identifies the extension in this profile"/> <formal value="A unique code (within the profile) used to identify the extension."/> <comments value="Matches the portion of a reference to an extension after the # in the a url to the profile."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <constraint> <key value="5"/> <severity value="error"/> <human value="Codes SHALL be unique in the context of a profile"/> <xpath value="count(ancestor::f:Profile/f:extensionDefn/f:code[@value=current()/@value])=1"/> </constraint> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.extensionDefn.display"/> <definition> <short value="Use this name when displaying the value"/> <formal value="Defined so that applications can use this name when displaying the value of the extension to the user."/> <comments value="Applications don't have to use this name, but can always fall back to it."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.extensionDefn.contextType"/> <definition> <short value="resource | datatype | mapping | extension"/> <formal value="Identifies the type of context to which the extension applies."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="ExtensionContext"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/extension-context"/> </referenceResource> </binding> </definition> </element> <element> <path value="Profile.extensionDefn.context"/> <definition> <short value="Where the extension can be used in instances"/> <formal value="Identifies the types of resource or data type elements to which the extension can be applied."/> <min value="1"/> <max value="*"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.extensionDefn.definition"/> <definition> <short value="Definition of the extension and its content"/> <formal value="Definition of the extension and its content."/> <min value="1"/> <max value="1"/> <nameReference value="Profile.structure.element.definition"/> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.query"/> <definition> <short value="Definition of a named query"/> <formal value="Definition of a named query and its parameters and their meaning."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.query.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.query.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.query.name"/> <definition> <short value="Special named queries (_query=)"/> <formal value="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 value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.query.documentation"/> <definition> <short value="Describes the named query"/> <formal value="Description of the query - the functionality it offers, and considerations about how it functions and to use it."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Profile.query.parameter"/> <definition> <short value="Parameter for the named query"/> <formal value="A parameter of a named query."/> <min value="0"/> <max value="*"/> <nameReference value="Profile.structure.searchParam"/> <isModifier value="false"/> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="code"/> <type value="token"/> <documentation value="A code for the profile in the format uri::code (server may choose to do subsumption)"/> <xpath value="f:Profile/f:code"/> </searchParam> <searchParam> <name value="date"/> <type value="date"/> <documentation value="The profile publication date"/> <xpath value="f:Profile/f:date"/> </searchParam> <searchParam> <name value="description"/> <type value="string"/> <documentation value="Text search in the description of the profile"/> <xpath value="f:Profile/f:description"/> </searchParam> <searchParam> <name value="extension"/> <type value="token"/> <documentation value="An extension code (use or definition)"/> <xpath value="f:Profile/f:extensionDefn/f:code"/> </searchParam> <searchParam> <name value="identifier"/> <type value="token"/> <documentation value="The identifier of the profile"/> <xpath value="f:Profile/f:identifier"/> </searchParam> <searchParam> <name value="name"/> <type value="string"/> <documentation value="Name of the profile"/> <xpath value="f:Profile/f:name"/> </searchParam> <searchParam> <name value="publisher"/> <type value="string"/> <documentation value="Name of the publisher of the profile"/> <xpath value="f:Profile/f:publisher"/> </searchParam> <searchParam> <name value="status"/> <type value="token"/> <documentation value="The current status of the profile"/> <xpath value="f:Profile/f:status"/> </searchParam> <searchParam> <name value="type"/> <type value="token"/> <documentation value="Type of resource that is constrained in the profile"/> <xpath value="f:Profile/f:structure/f:type"/> </searchParam> <searchParam> <name value="valueset"/> <type value="reference"/> <documentation value="A vocabulary binding code"/> <xpath value="f:Profile/f:structure/f:element/f:definition/f:binding/f:reference[x]"/> </searchParam> <searchParam> <name value="version"/> <type value="token"/> <documentation value="The version identifier of the profile"/> <xpath value="f:Profile/f:version"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="profile-definitions.html#Profile" 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."><b>Profile</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="profile-definitions.html#Profile.identifier" 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)."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.version" 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."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.name" title="A free text natural language name identifying the Profile."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.publisher" title="Details of the individual or organization who accepts responsibility for publishing the profile."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.telecom" title="Contact details to assist a user in finding and communicating with the publisher."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></telecom> <<a class="dict" href="profile-definitions.html#Profile.description" title="A free text natural language description of the profile and its use."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.code" title="A set of terms from external terminologies that may be used to assist with indexing and searching of templates."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></code> <<a class="dict" href="profile-definitions.html#Profile.status" title="The status of the profile (this element modifies the meaning of other elements)"><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 href="resource-profile-status.html" style="color: navy">draft | active | retired<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.experimental" title="This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.date" title="The date that this version of the profile was published."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.requirements" title="The Scope and Usage that this profile was created to meet."><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> <<a class="dict" href="profile-definitions.html#Profile.fhirVersion" title="The version of the FHIR specification on which this profile is based."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.mapping" title="An external specification that the content is mapped to."><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> <<a class="dict" href="profile-definitions.html#Profile.mapping.identity" title="An Internal id that is used to identify this mapping set when specific mappings are made."><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> <<a class="dict" href="profile-definitions.html#Profile.mapping.uri" title="A URI that identifies the specification that this mapping is expressed to."><b>uri</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#uri">uri</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-26: Must have at a name or a uri (or both)"><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> <<a class="dict" href="profile-definitions.html#Profile.mapping.name" title="A name for the specification that is being mapped to."><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" title="Inv-26: Must have at a name or a uri (or both)"><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> <<a class="dict" href="profile-definitions.html#Profile.mapping.comments" title="Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage."><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> </mapping> <<a class="dict" href="profile-definitions.html#Profile.structure" title="A constraint statement about what contents a resource or data type may have."><b>structure</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-8: SHALL define at least one structure constraint or extension definition"><b><img alt="??" src="lock.png"/> 0..*</b></span> A constraint on a resource or a data type --></span> <<a class="dict" href="profile-definitions.html#Profile.structure.type" title="The Resource or Data type being described."><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" title="Inv-12: Only complex types can be constrained, not primitive types such as string etc."><b><img alt="??" src="lock.png"/> 1..1</b></span> <span style="color: navy"><a href="defined-types.html" style="color: navy">The Resource or Data Type being described</a></span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.structure.name" title="The name of this resource constraint statement (to refer to it from other resource constraints - from Profile.structure.element.definition.type.profile)."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.publish" 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."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.purpose" title="Human summary: why describe this resource?."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element" title="Captures constraints on each element within the resource."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.path" title="The path identifies the element and is expressed as a "."-separated list of ancestor elements, beginning with the name of the resource."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.representation" title="Codes that define how this element is represented in instances, when the deviation varies from the normal case."><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 href="property-representation.html" style="color: navy">How this element is represented in instances</a></span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.structure.element.name" 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."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.slicing" 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)."><b>slicing</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..1</b></span> This element is sliced - slices follow --></span> <<a class="dict" href="profile-definitions.html#Profile.structure.element.slicing.discriminator" 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."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.slicing.ordered" title="If the matching elements have to occur in the same order as defined in the profile."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.slicing.rules" 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."><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 href="resource-slicing-rules.html" style="color: navy">closed | open | openAtEnd</a></span><span style="color: Gray"> --></span> </slicing> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition" title="Definition of the content of the element to provide a more specific definition than that contained for the element in the base resource."><b>definition</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..1</b></span> More specific definition of the element --></span> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.short" title="A concise definition that is shown in the generated XML format that summarizes profiles (used throughout the specification)."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.formal" 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."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.comments" title="Comments about the use of the element, including notes about how to use the data properly, exceptions to proper use, etc."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.requirements" title="Explains why this element is needed and why it's been constrained as it has."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.synonym" title="Identifies additional names by which this element might also be known."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.min" title="The minimum number of times this element SHALL appear in the instance."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.max" title="The maximum number of times this element is permitted to appear in the instance."><b>max</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-6: Max SHALL be a number or "*""><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.type" title="The data type or resource that the value of this element is permitted to be."><b>type</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Data type and Profile for this element --></span> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.type.code" title="Name of Data type or Resource."><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 href="data-types.html" style="color: navy">Name of Data type or Resource</a></span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.type.profile" 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."><b>profile</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#uri">uri</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-8: SHALL define at least one structure constraint or extension definition"><b><img alt="??" src="lock.png"/> 0..1</b></span> <span style="color: navy">Profile.structure to apply</span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.type.aggregation" 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."><b>aggregation</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#code">code</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-9: Aggregation may only be specified if one of the allowed types for the element is a resource"><b><img alt="??" src="lock.png"/> 0..*</b></span> <span style="color: navy"><a href="resource-aggregation-mode.html" style="color: navy">contained | referenced | bundled - how aggregated</a></span><span style="color: Gray"> --></span> </type> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.nameReference" title="Identifies the name of a slice defined elsewhere in the profile whose constraints should be applied to the current element."><b>nameReference</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-2: Either a namereference or a fixed value (but not both) is permitted"><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.value_x_" title="Specifies a primitive value that SHALL hold for this element in the instance."><b>value[x]</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" 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."><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]> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.example_x_" title="An example value for this element."><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]> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.maxLength" title="Indicates the shortest length that SHALL be supported by conformant instances without truncation."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.condition" title="A reference to an invariant that may make additional statements about the cardinality or value in the instance."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.constraint" title="Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance."><b>constraint</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Condition that must evaluate to true --></span> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.constraint.key" title="Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.constraint.name" title="Used to label the constraint in OCL or in short displays incapable of displaying the full human description."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.constraint.severity" title="Identifies the impact constraint violation has on the conformance of the instance."><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 href="constraint-severity.html" style="color: navy">error | warning</a></span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.constraint.human" title="Text that can be used to describe the constraint in messages identifying that the constraint has been violated."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.constraint.xpath" title="XPath expression of constraint."><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> </constraint> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.mustSupport" 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."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.isModifier" 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."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.binding" title="Binds to a value set if this element is coded (code, Coding, CodeableConcept)."><b>binding</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-12: Only complex types can be constrained, not primitive types such as string etc."><b><img alt="??" src="lock.png"/> 0..1</b></span> ValueSet details if this is coded --></span> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.binding.name" title="A descriptive name for this - can be useful for generating implementation artifacts."><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" title="Inv-11: Must have either a slice or a definition, but not both"><b><img alt="??" src="lock.png"/> 1..1</b></span> <span style="color: navy">Descriptive Name</span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.binding.isExtensible" 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."><b>isExtensible</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#boolean">boolean</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-14: Example value sets are always extensible"><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.binding.conformance" title="Indicates the degree of conformance expectations associated with this binding."><b>conformance</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#code">code</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-14: Example value sets are always extensible"><b><img alt="??" src="lock.png"/> 0..1</b></span> <span style="color: navy"><a href="binding-conformance.html" style="color: navy">required | preferred | example</a></span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.binding.description" title="Describes the intended use of this particular set of codes."><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" title="Inv-3: provide either a reference or a description (or both)"><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> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.binding.reference_x_" title="Points to the value set or external definition that identifies the set of codes to be used."><b>reference[x]</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-3: provide either a reference or a description (or both)"><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]> </binding> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.mapping" title="Identifies a concept from an external specification that roughly corresponds to this element."><b>mapping</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Map element to another set of definitions --></span> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.mapping.identity" title="An internal reference to the definition of a mapping."><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" title="Inv-26: Must have at a name or a uri (or both)"><b><img alt="??" src="lock.png"/> 1..1</b></span> <span style="color: navy">Reference to mapping declaration</span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.structure.element.definition.mapping.map" title="Expresses what part of the target specification corresponds to this element."><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> </mapping> </definition> </element> <<a class="dict" href="profile-definitions.html#Profile.structure.searchParam" title="Additional search parameters for implementations to support and/or make use of."><b>searchParam</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Search params defined --></span> <<a class="dict" href="profile-definitions.html#Profile.structure.searchParam.name" title="The name of the standard or custom search parameter."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.searchParam.type" title="The type of value a search parameter refers to, and how the content is interpreted."><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 href="search-param-type.html" style="color: navy">number | date | string | token | reference | composite | quantity</a></span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.structure.searchParam.documentation" 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."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.searchParam.xpath" title="An XPath expression that returns a set of elements for the search parameter."><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> <<a class="dict" href="profile-definitions.html#Profile.structure.searchParam.target" title="Types of resource (if a resource is referenced)."><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 href="resource-types.html" style="color: navy">Types of resource (if a resource reference)</a></span><span style="color: Gray"> --></span> </searchParam> </structure> <<a class="dict" href="profile-definitions.html#Profile.extensionDefn" title="An extension defined as part of the profile."><b>extensionDefn</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-8: SHALL define at least one structure constraint or extension definition"><b><img alt="??" src="lock.png"/> 0..*</b></span> Definition of an extension --></span> <<a class="dict" href="profile-definitions.html#Profile.extensionDefn.code" title="A unique code (within the profile) used to identify the extension."><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" title="Inv-5: Codes SHALL be unique in the context of a profile"><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> <<a class="dict" href="profile-definitions.html#Profile.extensionDefn.display" title="Defined so that applications can use this name when displaying the value of the extension to the user."><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> <<a class="dict" href="profile-definitions.html#Profile.extensionDefn.contextType" title="Identifies the type of context to which the extension applies."><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 href="extension-context.html" style="color: navy">resource | datatype | mapping | extension</a></span><span style="color: Gray"> --></span> <<a class="dict" href="profile-definitions.html#Profile.extensionDefn.context" title="Identifies the types of resource or data type elements to which the extension can be applied."><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> <<a class="dict" href="profile-definitions.html#Profile.extensionDefn.definition" title="Definition of the extension and its content."><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> </extensionDefn> <<a class="dict" href="profile-definitions.html#Profile.query" title="Definition of a named query and its parameters and their meaning."><b>query</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Definition of a named query --></span> <<a class="dict" href="profile-definitions.html#Profile.query.name" 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."><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> <<a class="dict" href="profile-definitions.html#Profile.query.documentation" title="Description of the query - the functionality it offers, and considerations about how it functions and to use it."><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> <<a class="dict" href="profile-definitions.html#Profile.query.parameter" title="A parameter of a named query."><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> </query> </Profile> </pre></div> </summary> </entry> <entry> <title>"provenance" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/provenance</id> <link href="http://hl7.org/implement/standards/fhir/provenance.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="provenance-definitions.html#Provenance" 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."><b>Provenance</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="provenance-definitions.html#Provenance.target" 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."><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> <<a class="dict" href="provenance-definitions.html#Provenance.period" title="The period during which the activity occurred."><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> <<a class="dict" href="provenance-definitions.html#Provenance.recorded" title="The instant of time at which the activity was 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> <<a class="dict" href="provenance-definitions.html#Provenance.reason" title="The reason that the activity was taking place."><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> <<a class="dict" href="provenance-definitions.html#Provenance.location" title="Where the activity occurred, if relevant."><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> <<a class="dict" href="provenance-definitions.html#Provenance.policy" 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."><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> <<a class="dict" href="provenance-definitions.html#Provenance.agent" 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."><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> <<a class="dict" href="provenance-definitions.html#Provenance.agent.role" title="The role that the participant played."><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 href="valueset-provenance-agent-role.html" style="color: navy">e.g. author | overseer | enterer | attester | source | cc: +</a></span><span style="color: Gray"> --></span></role> <<a class="dict" href="provenance-definitions.html#Provenance.agent.type" title="The type of the participant."><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 href="valueset-provenance-agent-type.html" style="color: navy">e.g. Resource | Person | Application | Record | Document +</a></span><span style="color: Gray"> --></span></type> <<a class="dict" href="provenance-definitions.html#Provenance.agent.reference" title="Identity of participant. May be a logical or physical uri and maybe absolute or relative."><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> <<a class="dict" href="provenance-definitions.html#Provenance.agent.display" title="Human-readable description of the participant."><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> </agent> <<a class="dict" href="provenance-definitions.html#Provenance.entity" title="An entity used in this activity."><b>entity</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> An entity used in this activity --></span> <<a class="dict" href="provenance-definitions.html#Provenance.entity.role" title="How the entity was used during the activity."><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 href="provenance-entity-role.html" style="color: navy">derivation | revision | quotation | source</a></span><span style="color: Gray"> --></span> <<a class="dict" href="provenance-definitions.html#Provenance.entity.type" title="The type of the entity. If the entity is a resource, then this is a resource 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 href="resource-types.html" style="color: navy">Resource Type, or something else</a><span style="color: Gray"> --></span></type> <<a class="dict" href="provenance-definitions.html#Provenance.entity.reference" title="Identity of participant. May be a logical or physical uri and maybe absolute or relative."><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> <<a class="dict" href="provenance-definitions.html#Provenance.entity.display" title="Human-readable description of the entity."><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> <<a class="dict" href="provenance-definitions.html#Provenance.entity.agent" 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."><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> </entity> <<a class="dict" href="provenance-definitions.html#Provenance.integritySignature" title="A digital signature on the target resource(s). The signature should match a Provenance.agent.referen ce 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."><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> </Provenance> </pre></div> </text> <name value="provenance"/> <publisher value="FHIR Project"/> <description value="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 value="draft"/> <date value="2014-09-30"/> <requirements value="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. Provenance 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 value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="w3c.prov"/> <uri value="http://www.w3.org/ns/prov"/> <name value="W3C PROV"/> </mapping> <structure> <type value="Provenance"/> <publish value="true"/> <element> <path value="Provenance"/> <definition> <short value="Who, What, When for a set of resources"/> <formal value="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 value="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 value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="ControlAct[isNormalAct() and subsumes(CACT, classCode) and moodCode=EVN]"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Activity"/> </mapping> </definition> </element> <element> <path value="Provenance.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Provenance.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Provenance.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Provenance.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Provenance.target"/> <definition> <short value="Target resource(s) (usually version specific)"/> <formal value="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 value="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 value="1"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Any"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./outboundRelationship[isNormalActRelationship() and typeCode=SUBJ]/target OR ./participation[isNo rmalParticipation() and typeCode=SBJ]/role OR ./participation[isNormalParticipation() and typeCode=SBJ]/role[isNormalRole()]/player"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Activity.wasGeneratedBy"/> </mapping> </definition> </element> <element> <path value="Provenance.period"/> <definition> <short value="When the activity occurred"/> <formal value="The period during which the activity occurred."/> <comments value="The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time."/> <min value="0"/> <max value="1"/> <type> <code value="Period"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./effectiveTime[type=IVL_TS]"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Activity.startTime & Activity.endTime"/> </mapping> </definition> </element> <element> <path value="Provenance.recorded"/> <definition> <short value="When the activity was recorded / updated"/> <formal value="The instant of time at which the activity was recorded."/> <comments value="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 value="1"/> <max value="1"/> <type> <code value="instant"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="unique(./participation[isNormalParticipation() and typeCode=AUT]/time[type=TS])"/> </mapping> </definition> </element> <element> <path value="Provenance.reason"/> <definition> <short value="Reason the activity is occurring"/> <formal value="The reason that the activity was taking place."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="unique(./reasonCode)"/> </mapping> </definition> </element> <element> <path value="Provenance.location"/> <definition> <short value="Where the activity occurred, if relevant"/> <formal value="Where the activity occurred, if relevant."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Location"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="unique(./participation[isNormalParticipation() and typeCode=LOC]/role[isNormalRole() and subsumes(SDLOC, classCode)]/player[isNormalEntity and classCode="LOC" and determinerCode=& quot;INST"]"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Activity.location"/> </mapping> </definition> </element> <element> <path value="Provenance.policy"/> <definition> <short value="Policy or plan the activity was defined by"/> <formal value="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 value="0"/> <max value="*"/> <type> <code value="uri"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./inboundRelationship[isNormalActRelationship() and typeCode="SUBJ"]/source[isNormalAct and subsumes(POLICY, classCode) and moodCode=EVN]/text[typeCode='ED'/tel"/> </mapping> </definition> </element> <element> <path value="Provenance.agent"/> <definition> <short value="Person, organization, records, etc. involved in creating resource"/> <formal value="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 value="Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./participation[isNormalParticipation()] OR ./outboundRelationship[isNormalActRelationship() and typeCode='DRIV']"/> </mapping> </definition> </element> <element> <path value="Provenance.agent.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Provenance.agent.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Provenance.agent.role"/> <definition> <short value="e.g. author | overseer | enterer | attester | source | cc: +"/> <formal value="The role that the participant played."/> <min value="1"/> <max value="1"/> <type> <code value="Coding"/> </type> <isModifier value="false"/> <binding> <name value="ProvenanceAgentRole"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/provenance-agent-role"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="attester: .[self::participation]/typeCode='RESP' author: .[self::participation]/typeCode='AUT' cc: .[self::participation]/typeCode='IRCP' enterer: .[self::participation]/typeCode='ENT' informant: .[self::participation]/typeCode='INF' performer: .[self::participation]/typeCode='PRF' verifier: .[self::participation]/typeCode='VRF' source: .[self::outboundRelationship]/typeCode=''"/> </mapping> </definition> </element> <element> <path value="Provenance.agent.type"/> <definition> <short value="e.g. Resource | Person | Application | Record | Document +"/> <formal value="The type of the participant."/> <comments value="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 value="1"/> <max value="1"/> <type> <code value="Coding"/> </type> <isModifier value="false"/> <binding> <name value="ProvenanceAgentType"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/provenance-agent-type"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="person: ./role[isNormalRole() and classCode='REL']/player[isNormalEntity and classCode='PER' and determinerCode='INST'] agent: ./role[isNormalRole() and classCode='ASSIGNED' and player[isNormal Entity and classCode='PSN' and determinerCode='INST']] organization: ./role[isNormalRole() and classCode='ASSIGNED' and not(player)]/scoper[isNormalEntity and classCode='ORG' and determinerCode='INST'] software: ./role[isNormalRole() and classCode='ASSIGNED']/scoper[isNormalEnt ity and classCode='DEV' and determinerCode='INST' and hasDomain(code, 'Software')] document: ./target[isNormalAct and subsumes('DOC', classCode) and moodCode='EVN']"/> </mapping> </definition> </element> <element> <path value="Provenance.agent.reference"/> <definition> <short value="Identity of agent (urn or url)"/> <formal value="Identity of participant. May be a logical or physical uri and maybe absolute or relative."/> <comments value="identity may be a reference to a resource or to something else, depending on the type."/> <min value="1"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./id"/> </mapping> </definition> </element> <element> <path value="Provenance.agent.display"/> <definition> <short value="Human description of participant"/> <formal value="Human-readable description of the participant."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./player/description OR ./description OR ./text"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Agent.label"/> </mapping> </definition> </element> <element> <path value="Provenance.entity"/> <definition> <short value="An entity used in this activity"/> <formal value="An entity used in this activity."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./subjectOf"/> </mapping> </definition> </element> <element> <path value="Provenance.entity.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Provenance.entity.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Provenance.entity.role"/> <definition> <short value="derivation | revision | quotation | source"/> <formal value="How the entity was used during the activity."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="ProvenanceEntityRole"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/provenance-entity-role"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="./typeCode"/> </mapping> </definition> </element> <element> <path value="Provenance.entity.type"/> <definition> <short value="Resource Type, or something else"/> <formal value="The type of the entity. If the entity is a resource, then this is a resource type."/> <comments value="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 value="1"/> <max value="1"/> <type> <code value="Coding"/> </type> <isModifier value="false"/> <binding> <name value="ProvenanceEntityType"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/resource-types"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="./target"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Entity.type"/> </mapping> </definition> </element> <element> <path value="Provenance.entity.reference"/> <definition> <short value="Identity of participant (urn or url)"/> <formal value="Identity of participant. May be a logical or physical uri and maybe absolute or relative."/> <comments value="identity may be a reference to a resource or to something else, depending on the type."/> <min value="1"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./text/reference"/> </mapping> </definition> </element> <element> <path value="Provenance.entity.display"/> <definition> <short value="Human description of participant"/> <formal value="Human-readable description of the entity."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./title"/> </mapping> </definition> </element> <element> <path value="Provenance.entity.agent"/> <definition> <short value="Entity is attributed to this agent"/> <formal value="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 value="0"/> <max value="1"/> <nameReference value="Provenance.agent"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./author/role"/> </mapping> </definition> </element> <element> <path value="Provenance.integritySignature"/> <definition> <short value="Base64 signature (DigSig) - integrity check"/> <formal value="A digital signature on the target resource(s). The signature should match a Provenance.agent.referen ce 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 value="Whether the content is XML or JSON, the representation is as a base64 of the XML signature of the resource."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./signatureText"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="end"/> <type value="date"/> <documentation value="End time with inclusive boundary, if not ongoing"/> <xpath value="f:Provenance/f:period/f:end"/> </searchParam> <searchParam> <name value="location"/> <type value="reference"/> <documentation value="Where the activity occurred, if relevant"/> <xpath value="f:Provenance/f:location"/> </searchParam> <searchParam> <name value="party"/> <type value="token"/> <documentation value="Identity of agent (urn or url)"/> <xpath value="f:Provenance/f:agent/f:reference"/> </searchParam> <searchParam> <name value="partytype"/> <type value="token"/> <documentation value="e.g. Resource | Person | Application | Record | Document +"/> <xpath value="f:Provenance/f:agent/f:type"/> </searchParam> <searchParam> <name value="start"/> <type value="date"/> <documentation value="Starting time with inclusive boundary"/> <xpath value="f:Provenance/f:period/f:start"/> </searchParam> <searchParam> <name value="target"/> <type value="reference"/> <documentation value="Target resource(s) (usually version specific)"/> <xpath value="f:Provenance/f:target"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="provenance-definitions.html#Provenance" 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."><b>Provenance</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="provenance-definitions.html#Provenance.target" 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."><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> <<a class="dict" href="provenance-definitions.html#Provenance.period" title="The period during which the activity occurred."><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> <<a class="dict" href="provenance-definitions.html#Provenance.recorded" title="The instant of time at which the activity was 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> <<a class="dict" href="provenance-definitions.html#Provenance.reason" title="The reason that the activity was taking place."><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> <<a class="dict" href="provenance-definitions.html#Provenance.location" title="Where the activity occurred, if relevant."><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> <<a class="dict" href="provenance-definitions.html#Provenance.policy" 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."><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> <<a class="dict" href="provenance-definitions.html#Provenance.agent" 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."><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> <<a class="dict" href="provenance-definitions.html#Provenance.agent.role" title="The role that the participant played."><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 href="valueset-provenance-agent-role.html" style="color: navy">e.g. author | overseer | enterer | attester | source | cc: +</a></span><span style="color: Gray"> --></span></role> <<a class="dict" href="provenance-definitions.html#Provenance.agent.type" title="The type of the participant."><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 href="valueset-provenance-agent-type.html" style="color: navy">e.g. Resource | Person | Application | Record | Document +</a></span><span style="color: Gray"> --></span></type> <<a class="dict" href="provenance-definitions.html#Provenance.agent.reference" title="Identity of participant. May be a logical or physical uri and maybe absolute or relative."><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> <<a class="dict" href="provenance-definitions.html#Provenance.agent.display" title="Human-readable description of the participant."><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> </agent> <<a class="dict" href="provenance-definitions.html#Provenance.entity" title="An entity used in this activity."><b>entity</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> An entity used in this activity --></span> <<a class="dict" href="provenance-definitions.html#Provenance.entity.role" title="How the entity was used during the activity."><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 href="provenance-entity-role.html" style="color: navy">derivation | revision | quotation | source</a></span><span style="color: Gray"> --></span> <<a class="dict" href="provenance-definitions.html#Provenance.entity.type" title="The type of the entity. If the entity is a resource, then this is a resource 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 href="resource-types.html" style="color: navy">Resource Type, or something else</a><span style="color: Gray"> --></span></type> <<a class="dict" href="provenance-definitions.html#Provenance.entity.reference" title="Identity of participant. May be a logical or physical uri and maybe absolute or relative."><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> <<a class="dict" href="provenance-definitions.html#Provenance.entity.display" title="Human-readable description of the entity."><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> <<a class="dict" href="provenance-definitions.html#Provenance.entity.agent" 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."><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> </entity> <<a class="dict" href="provenance-definitions.html#Provenance.integritySignature" title="A digital signature on the target resource(s). The signature should match a Provenance.agent.referen ce 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."><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> </Provenance> </pre></div> </summary> </entry> <entry> <title>"query" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/query</id> <link href="http://hl7.org/implement/standards/fhir/query.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="query-definitions.html#Query" title="A description of a query with a set of parameters."><b>Query</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="query-definitions.html#Query.identifier" title="Links query and its response(s)."><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> <<a class="dict" href="query-definitions.html#Query.parameter" title="Set of query parameters with values."><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> <<a class="dict" href="query-definitions.html#Query.response" title="If this is a response to a query."><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> <<a class="dict" href="query-definitions.html#Query.response.identifier" title="Links response to source query."><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> <<a class="dict" href="query-definitions.html#Query.response.outcome" title="Outcome of processing the query."><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 href="query-outcome.html" style="color: navy">ok | limited | refused | error</a></span><span style="color: Gray"> --></span> <<a class="dict" href="query-definitions.html#Query.response.total" title="Total number of matching records."><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> <<a class="dict" href="query-definitions.html#Query.response.parameter" title="Parameters server used."><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> <<a class="dict" href="query-definitions.html#Query.response.first" title="To get first page (if paged)."><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> <<a class="dict" href="query-definitions.html#Query.response.previous" title="To get previous page (if paged)."><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> <<a class="dict" href="query-definitions.html#Query.response.next" title="To get next page (if paged)."><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> <<a class="dict" href="query-definitions.html#Query.response.last" title="To get last page (if paged)."><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> <<a class="dict" href="query-definitions.html#Query.response.reference" title="Resources that are the results of the search."><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> </response> </Query> </pre></div> </text> <name value="query"/> <publisher value="FHIR Project"/> <description value="Basic Profile. A description of a query with a set of parameters."/> <status value="draft"/> <date value="2014-09-30"/> <requirements value="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 value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <structure> <type value="Query"/> <publish value="true"/> <element> <path value="Query"/> <definition> <short value="A description of a query with a set of parameters"/> <formal value="A description of a query with a set of parameters."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="QuerySpec"/> </mapping> </definition> </element> <element> <path value="Query.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Query.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Query.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Query.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Query.identifier"/> <definition> <short value="Links query and its response(s)"/> <formal value="Links query and its response(s)."/> <min value="1"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".queryId"/> </mapping> </definition> </element> <element> <path value="Query.parameter"/> <definition> <short value="Set of query parameters with values"/> <formal value="Set of query parameters with values."/> <comments value="Unless otherwise specified, parameters are usually strings."/> <min value="1"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".parameter"/> </mapping> </definition> </element> <element> <path value="Query.response"/> <definition> <short value="If this is a response to a query"/> <formal value="If this is a response to a query."/> <min value="0"/> <max value="1"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="QueryAck (indirectly linked through .queryId, directly linked via Message.acknowledges"/> </mapping> </definition> </element> <element> <path value="Query.response.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Query.response.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Query.response.identifier"/> <definition> <short value="Links response to source query"/> <formal value="Links response to source query."/> <min value="1"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".queryId?"/> </mapping> </definition> </element> <element> <path value="Query.response.outcome"/> <definition> <short value="ok | limited | refused | error"/> <formal value="Outcome of processing the query."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="QueryOutcome"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/query-outcome"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".queryResponseCode"/> </mapping> </definition> </element> <element> <path value="Query.response.total"/> <definition> <short value="Total number of matching records"/> <formal value="Total number of matching records."/> <min value="0"/> <max value="1"/> <type> <code value="integer"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".resultTotalQuantity"/> </mapping> </definition> </element> <element> <path value="Query.response.parameter"/> <definition> <short value="Parameters server used"/> <formal value="Parameters server used."/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Not supported"/> </mapping> </definition> </element> <element> <path value="Query.response.first"/> <definition> <short value="To get first page (if paged)"/> <formal value="To get first page (if paged)."/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Not supported"/> </mapping> </definition> </element> <element> <path value="Query.response.previous"/> <definition> <short value="To get previous page (if paged)"/> <formal value="To get previous page (if paged)."/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Not supported"/> </mapping> </definition> </element> <element> <path value="Query.response.next"/> <definition> <short value="To get next page (if paged)"/> <formal value="To get next page (if paged)."/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".continuationToken"/> </mapping> </definition> </element> <element> <path value="Query.response.last"/> <definition> <short value="To get last page (if paged)"/> <formal value="To get last page (if paged)."/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Not supported"/> </mapping> </definition> </element> <element> <path value="Query.response.reference"/> <definition> <short value="Resources that are the results of the search"/> <formal value="Resources that are the results of the search."/> <comments value="Is query only used in messaging?."/> <min value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Any"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".controlAct.outboundRelationship[typeCode=SUBJ].target or .controlAct.participation[typeCode=SBJ].ro le"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="identifier"/> <type value="token"/> <documentation value="Links query and its response(s)"/> <xpath value="f:Query/f:identifier"/> </searchParam> <searchParam> <name value="response"/> <type value="token"/> <documentation value="Links response to source query"/> <xpath value="f:Query/f:response/f:identifier"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="query-definitions.html#Query" title="A description of a query with a set of parameters."><b>Query</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="query-definitions.html#Query.identifier" title="Links query and its response(s)."><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> <<a class="dict" href="query-definitions.html#Query.parameter" title="Set of query parameters with values."><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> <<a class="dict" href="query-definitions.html#Query.response" title="If this is a response to a query."><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> <<a class="dict" href="query-definitions.html#Query.response.identifier" title="Links response to source query."><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> <<a class="dict" href="query-definitions.html#Query.response.outcome" title="Outcome of processing the query."><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 href="query-outcome.html" style="color: navy">ok | limited | refused | error</a></span><span style="color: Gray"> --></span> <<a class="dict" href="query-definitions.html#Query.response.total" title="Total number of matching records."><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> <<a class="dict" href="query-definitions.html#Query.response.parameter" title="Parameters server used."><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> <<a class="dict" href="query-definitions.html#Query.response.first" title="To get first page (if paged)."><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> <<a class="dict" href="query-definitions.html#Query.response.previous" title="To get previous page (if paged)."><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> <<a class="dict" href="query-definitions.html#Query.response.next" title="To get next page (if paged)."><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> <<a class="dict" href="query-definitions.html#Query.response.last" title="To get last page (if paged)."><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> <<a class="dict" href="query-definitions.html#Query.response.reference" title="Resources that are the results of the search."><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> </response> </Query> </pre></div> </summary> </entry> <entry> <title>"questionnaire" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/questionnaire</id> <link href="http://hl7.org/implement/standards/fhir/questionnaire.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="questionnaire-definitions.html#Questionnaire" 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."><b>Questionnaire</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.status" title="The lifecycle status of the questionnaire as a whole (this element modifies the meaning of other elements)"><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 href="questionnaire-status.html" style="color: navy">draft | published | retired | in progress | completed | amended<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.authored" title="The date and/or time that this version of the questionnaire was 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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.subject" 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."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></subject> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.author" title="Person who received the answers to the questions in the Questionnaire and recorded them in the system."><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"> Person who received and recorded the answers<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></author> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.source" title="The person who answered the questions about the subject. Only used when this is not the subject him/herself."><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"> The person who answered the questions<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></source> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.name" title="Structured name for a predefined list of questions this questionnaire is responding to."><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 href="valueset-questionnaire-name.html" style="color: navy">Name/code for a predefined list of questions<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></name> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.identifier" 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)."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></identifier> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.encounter" 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."><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"> Primary encounter during which the answers were collected<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></encounter> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.group" title="A group of questions to a possibly similarly grouped set of questions in the questionnaire."><b>group</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..1</b></span> Grouped questions --></span> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.group.name" title="Structured name for a section of a predefined list of questions this questionnaire is responding to."><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 href="valueset-questionnaire-group-name.html" style="color: navy">Code or name of the section on a questionnaire</a></span><span style="color: Gray"> --></span></name> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.group.header" title="Text that is displayed above the contents of the group."><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> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.group.text" title="Additional text for the group, used for display purposes."><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> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.group.subject" title="More specific subject this section's answers are about, details the subject given in Questionnaire."><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> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.group.group" title="A sub-group within a group. The ordering of groups within this group is relevant."><b>group</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-3: Groups may either contain questions or groups but not both"><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> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.group.question" title="Set of questions within this group. The order of questions within the group is relevant."><b>question</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-3: Groups may either contain questions or groups but not both"><b><img alt="??" src="lock.png"/> 0..*</b></span> Questions in this group --></span> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.group.question.name" title="Structured name for the question that identifies this question within the Questionnaire or Group."><b>name</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-2: Must supply a name, a question's text or both"><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 href="valueset-questionnaire-question-name.html" style="color: navy">Code or name of the question</a></span><span style="color: Gray"> --></span></name> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.group.question.text" title="Text of the question as it is shown to the user."><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" title="Inv-2: Must supply a name, a question's text or both"><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> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.group.question.answer_x_" title="Single-valued answer to the question."><b>answer[x]</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: Must supply either a simple answer, a choice, data or nothing"><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"> Single-valued answer to the question</span><span style="color: Gray"> --></span></answer[x]> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.group.question.choice" title="Selections made by the user from the list of options."><b>choice</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: Must supply either a simple answer, a choice, data or nothing"><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> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.group.question.options" title="Reference to a valueset containing the possible 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> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.group.question.data_x_" title="Structured answer in the form of a FHIR Resource or datatype."><b>data[x]</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: Must supply either a simple answer, a choice, data or nothing"><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]> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.group.question.remarks" 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."><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> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.group.question.group" title="Nested group, containing nested question for this question. The order of groups within the question is relevant."><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> </question> </group> </Questionnaire> </pre></div> </text> <name value="questionnaire"/> <publisher value="FHIR Project"/> <description value="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 value="draft"/> <date value="2014-09-30"/> <requirements value="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. Questionnaires 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. Examples of Questionnaires include: * Past medical history (PMH) * Family diseases * Social history * Research questionnaires * Quality and evaluation forms Support for validation is outside the scope of this Resource, although basic structural features can be defined using the Questionnaire core extensions."/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <structure> <type value="Questionnaire"/> <publish value="true"/> <element> <path value="Questionnaire"/> <definition> <short value="A structured set of questions and their answers"/> <formal value="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 value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Document[moodCode=DEF or EVN]"/> </mapping> </definition> </element> <element> <path value="Questionnaire.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Questionnaire.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Questionnaire.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Questionnaire.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Questionnaire.status"/> <definition> <short value="draft | published | retired | in progress | completed | amended"/> <formal value="The lifecycle status of the questionnaire as a whole."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="QuestionnaireStatus"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/questionnaire-status"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".statusCode (also whether there's a revisionControlAct - and possibly mood to distinguish "in progress" from "published)"/> </mapping> </definition> </element> <element> <path value="Questionnaire.authored"/> <definition> <short value="Date this version was authored"/> <formal value="The date and/or time that this version of the questionnaire was authored."/> <comments value="May be different from the update time of the resource itself, because that is the status of the collection and authoring."/> <min value="1"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=AUT].time"/> </mapping> </definition> </element> <element> <path value="Questionnaire.subject"/> <definition> <short value="The subject of the questions"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/RelatedPerson"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=SBJ].role"/> </mapping> </definition> </element> <element> <path value="Questionnaire.author"/> <definition> <short value="Person who received and recorded the answers"/> <formal value="Person who received the answers to the questions in the Questionnaire and recorded them in the system."/> <comments value="Mapping a subject's answers to multiple choice options and determining what to put in the textual answer is a matter of interpretation."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/RelatedPerson"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=AUT].role"/> </mapping> </definition> </element> <element> <path value="Questionnaire.source"/> <definition> <short value="The person who answered the questions"/> <formal value="The person who answered the questions about the subject. Only used when this is not the subject him/herself."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/RelatedPerson"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=INF].role"/> </mapping> </definition> </element> <element> <path value="Questionnaire.name"/> <definition> <short value="Name/code for a predefined list of questions"/> <formal value="Structured name for a predefined list of questions this questionnaire is responding to."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="QuestionnaireName"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/questionnaire-name"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".title"/> </mapping> </definition> </element> <element> <path value="Questionnaire.identifier"/> <definition> <short value="External Ids for this questionnaire"/> <formal value="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 value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> </definition> </element> <element> <path value="Questionnaire.encounter"/> <definition> <short value="Primary encounter during which the answers were collected"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Encounter"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"/> </mapping> </definition> </element> <element> <path value="Questionnaire.group"/> <definition> <short value="Grouped questions"/> <formal value="A group of questions to a possibly similarly grouped set of questions in the questionnaire."/> <comments value="The Questionnaire itself has one "root" group with the actual contents of the Questionnaire."/> <min value="0"/> <max value="1"/> <constraint> <key value="3"/> <name value="GroupHaveSubOrQuestions"/> <severity value="error"/> <human value="Groups may either contain questions or groups but not both"/> <xpath value="not(exists(f:group) and exists(f:question))"/> </constraint> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=COMP].target[classCode=DOCSECT, moodCode=EVN]"/> </mapping> </definition> </element> <element> <path value="Questionnaire.group.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Questionnaire.group.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Questionnaire.group.name"/> <definition> <short value="Code or name of the section on a questionnaire"/> <formal value="Structured name for a section of a predefined list of questions this questionnaire is responding to."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="QuestionnaireGroupName"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/questionnaire-group-name"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> </definition> </element> <element> <path value="Questionnaire.group.header"/> <definition> <short value="Text that is displayed above the contents of the group"/> <formal value="Text that is displayed above the contents of the group."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".title"/> </mapping> </definition> </element> <element> <path value="Questionnaire.group.text"/> <definition> <short value="Additional text for the group"/> <formal value="Additional text for the group, used for display purposes."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".text"/> </mapping> </definition> </element> <element> <path value="Questionnaire.group.subject"/> <definition> <short value="The subject this group's answers are about"/> <formal value="More specific subject this section's answers are about, details the subject given in Questionnaire."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Any"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=SBJ].role or .outboundRelationship[typeCode=SUBJ].target"/> </mapping> </definition> </element> <element> <path value="Questionnaire.group.group"/> <definition> <short value="Nested questionnaire group"/> <formal value="A sub-group within a group. The ordering of groups within this group is relevant."/> <min value="0"/> <max value="*"/> <nameReference value="Questionnaire.group"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=COMP].target[classCode=DOCSECT, moodCode=EVN]"/> </mapping> </definition> </element> <element> <path value="Questionnaire.group.question"/> <definition> <short value="Questions in this group"/> <formal value="Set of questions within this group. The order of questions within the group is relevant."/> <min value="0"/> <max value="*"/> <constraint> <key value="2"/> <name value="MustHaveNameOrText"/> <severity value="error"/> <human value="Must supply a name, a question's text or both"/> <xpath value="count(f:name) + count(f:text) >= 1"/> </constraint> <constraint> <key value="1"/> <name value="SimpleChoiceOrData"/> <severity value="error"/> <human value="Must supply either a simple answer, a choice, data or nothing"/> <xpath value="count(f:data) + count(f:choice) + count(f:answer) <= 1"/> </constraint> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN or DEF]"/> </mapping> </definition> </element> <element> <path value="Questionnaire.group.question.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Questionnaire.group.question.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Questionnaire.group.question.name"/> <definition> <short value="Code or name of the question"/> <formal value="Structured name for the question that identifies this question within the Questionnaire or Group."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="QuestionName"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/questionnaire-question-name"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> </definition> </element> <element> <path value="Questionnaire.group.question.text"/> <definition> <short value="Text of the question as it is shown to the user"/> <formal value="Text of the question as it is shown to the user."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".code.display"/> </mapping> </definition> </element> <element> <path value="Questionnaire.group.question.answer[x]"/> <definition> <short value="Single-valued answer to the question"/> <formal value="Single-valued answer to the question."/> <min value="0"/> <max value="1"/> <type> <code value="decimal"/> </type> <type> <code value="integer"/> </type> <type> <code value="boolean"/> </type> <type> <code value="date"/> </type> <type> <code value="string"/> </type> <type> <code value="dateTime"/> </type> <type> <code value="instant"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".value"/> </mapping> </definition> </element> <element> <path value="Questionnaire.group.question.choice"/> <definition> <short value="Selected options"/> <formal value="Selections made by the user from the list of options."/> <min value="0"/> <max value="*"/> <type> <code value="Coding"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Not supported - MIF/templating layer to capture value set"/> </mapping> </definition> </element> <element> <path value="Questionnaire.group.question.options"/> <definition> <short value="Valueset containing the possible options"/> <formal value="Reference to a valueset containing the possible options."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/ValueSet"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Not supported - MIF/templating layer to capture value set"/> </mapping> </definition> </element> <element> <path value="Questionnaire.group.question.data[x]"/> <definition> <short value="Structured answer"/> <formal value="Structured answer in the form of a FHIR Resource or datatype."/> <min value="0"/> <max value="1"/> <type> <code value="*"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=VALUE].target"/> </mapping> </definition> </element> <element> <path value="Questionnaire.group.question.remarks"/> <definition> <short value="Remarks about the answer given"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="annotation"] .value"/> </mapping> </definition> </element> <element> <path value="Questionnaire.group.question.group"/> <definition> <short value="Nested questionnaire group"/> <formal value="Nested group, containing nested question for this question. The order of groups within the question is relevant."/> <min value="0"/> <max value="*"/> <nameReference value="Questionnaire.group"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=COMP].target[classCode=DOCSECT, moodCode=EVN]"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="author"/> <type value="reference"/> <documentation value="The author of the questionnaire"/> <xpath value="f:Questionnaire/f:author"/> </searchParam> <searchParam> <name value="authored"/> <type value="date"/> <documentation value="When the questionnaire was authored"/> <xpath value="f:Questionnaire/f:authored"/> </searchParam> <searchParam> <name value="encounter"/> <type value="reference"/> <documentation value="Encounter during which questionnaire was authored"/> <xpath value="f:Questionnaire/f:encounter"/> </searchParam> <searchParam> <name value="identifier"/> <type value="token"/> <documentation value="An identifier for the questionnaire"/> <xpath value="f:Questionnaire/f:identifier"/> </searchParam> <searchParam> <name value="name"/> <type value="token"/> <documentation value="Name of the questionnaire"/> <xpath value="f:Questionnaire/f:name"/> </searchParam> <searchParam> <name value="status"/> <type value="token"/> <documentation value="The status of the questionnaire"/> <xpath value="f:Questionnaire/f:status"/> </searchParam> <searchParam> <name value="subject"/> <type value="reference"/> <documentation value="The subject of the questionnaire"/> <xpath value="f:Questionnaire/f:subject"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="questionnaire-definitions.html#Questionnaire" 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."><b>Questionnaire</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.status" title="The lifecycle status of the questionnaire as a whole (this element modifies the meaning of other elements)"><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 href="questionnaire-status.html" style="color: navy">draft | published | retired | in progress | completed | amended<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.authored" title="The date and/or time that this version of the questionnaire was 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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.subject" 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."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></subject> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.author" title="Person who received the answers to the questions in the Questionnaire and recorded them in the system."><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"> Person who received and recorded the answers<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></author> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.source" title="The person who answered the questions about the subject. Only used when this is not the subject him/herself."><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"> The person who answered the questions<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></source> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.name" title="Structured name for a predefined list of questions this questionnaire is responding to."><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 href="valueset-questionnaire-name.html" style="color: navy">Name/code for a predefined list of questions<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></name> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.identifier" 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)."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></identifier> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.encounter" 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."><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"> Primary encounter during which the answers were collected<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></encounter> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.group" title="A group of questions to a possibly similarly grouped set of questions in the questionnaire."><b>group</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..1</b></span> Grouped questions --></span> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.group.name" title="Structured name for a section of a predefined list of questions this questionnaire is responding to."><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 href="valueset-questionnaire-group-name.html" style="color: navy">Code or name of the section on a questionnaire</a></span><span style="color: Gray"> --></span></name> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.group.header" title="Text that is displayed above the contents of the group."><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> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.group.text" title="Additional text for the group, used for display purposes."><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> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.group.subject" title="More specific subject this section's answers are about, details the subject given in Questionnaire."><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> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.group.group" title="A sub-group within a group. The ordering of groups within this group is relevant."><b>group</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-3: Groups may either contain questions or groups but not both"><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> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.group.question" title="Set of questions within this group. The order of questions within the group is relevant."><b>question</b></a>> <span style="color: Gray"><!-- <span style="color: brown" title="Inv-3: Groups may either contain questions or groups but not both"><b><img alt="??" src="lock.png"/> 0..*</b></span> Questions in this group --></span> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.group.question.name" title="Structured name for the question that identifies this question within the Questionnaire or Group."><b>name</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-2: Must supply a name, a question's text or both"><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 href="valueset-questionnaire-question-name.html" style="color: navy">Code or name of the question</a></span><span style="color: Gray"> --></span></name> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.group.question.text" title="Text of the question as it is shown to the user."><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" title="Inv-2: Must supply a name, a question's text or both"><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> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.group.question.answer_x_" title="Single-valued answer to the question."><b>answer[x]</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: Must supply either a simple answer, a choice, data or nothing"><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"> Single-valued answer to the question</span><span style="color: Gray"> --></span></answer[x]> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.group.question.choice" title="Selections made by the user from the list of options."><b>choice</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: Must supply either a simple answer, a choice, data or nothing"><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> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.group.question.options" title="Reference to a valueset containing the possible 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> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.group.question.data_x_" title="Structured answer in the form of a FHIR Resource or datatype."><b>data[x]</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: Must supply either a simple answer, a choice, data or nothing"><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]> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.group.question.remarks" 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."><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> <<a class="dict" href="questionnaire-definitions.html#Questionnaire.group.question.group" title="Nested group, containing nested question for this question. The order of groups within the question is relevant."><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> </question> </group> </Questionnaire> </pre></div> </summary> </entry> <entry> <title>"relatedperson" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/relatedperson</id> <link href="http://hl7.org/implement/standards/fhir/relatedperson.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="relatedperson-definitions.html#RelatedPerson" 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."><b>RelatedPerson</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="relatedperson-definitions.html#RelatedPerson.identifier" title="Identifier for a person within a particular scope."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></identifier> <<a class="dict" href="relatedperson-definitions.html#RelatedPerson.patient" title="The patient this person is related to."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></patient> <<a class="dict" href="relatedperson-definitions.html#RelatedPerson.relationship" title="The nature of the relationship between a patient and the related person."><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 href="valueset-relatedperson-relationshiptype.html" style="color: navy">The nature of the relationship<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></relationship> <<a class="dict" href="relatedperson-definitions.html#RelatedPerson.name" title="A name associated with the person."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></name> <<a class="dict" href="relatedperson-definitions.html#RelatedPerson.telecom" title="A contact detail for the person, e.g. a telephone number or an email address."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></telecom> <<a class="dict" href="relatedperson-definitions.html#RelatedPerson.gender" title="Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes."><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 href="valueset-administrative-gender.html" style="color: navy">Gender for administrative purposes<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></gender> <<a class="dict" href="relatedperson-definitions.html#RelatedPerson.address" title="Address where the related person can be contacted or visited."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></address> <<a class="dict" href="relatedperson-definitions.html#RelatedPerson.photo" title="Image of the person."><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> </RelatedPerson> </pre></div> </text> <name value="relatedperson"/> <publisher value="FHIR Project"/> <description value="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 value="draft"/> <date value="2014-09-30"/> <requirements value="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. Example RelatedPersons are: * A patient's wife or husband * A patient's relatives or friends * A neighbor bringing a patient to the hospital * The owner or trainer of a horse * A patient's attorney or guardian"/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <structure> <type value="RelatedPerson"/> <publish value="true"/> <element> <path value="RelatedPerson"/> <definition> <short value="An person that is related to a patient, but who is not a direct target of care"/> <formal value="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 value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="role"/> </mapping> </definition> </element> <element> <path value="RelatedPerson.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="RelatedPerson.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="RelatedPerson.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="RelatedPerson.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="RelatedPerson.identifier"/> <definition> <short value="A Human identifier for this person"/> <formal value="Identifier for a person within a particular scope."/> <min value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="id"/> </mapping> <mapping> <identity value="v2"/> <map value="NK1-33"/> </mapping> </definition> </element> <element> <path value="RelatedPerson.patient"/> <definition> <short value="The patient this person is related to"/> <formal value="The patient this person is related to."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="scoper[classCode=PSN|ANM and determinerCode='INSTANCE']/playedRole[classCode='PAT']/id"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-3"/> </mapping> </definition> </element> <element> <path value="RelatedPerson.relationship"/> <definition> <short value="The nature of the relationship"/> <formal value="The nature of the relationship between a patient and the related person."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="PatientRelationshipType"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/relatedperson-relationshiptype"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="code"/> </mapping> <mapping> <identity value="v2"/> <map value="NK1-3"/> </mapping> </definition> </element> <element> <path value="RelatedPerson.name"/> <definition> <short value="A name associated with the person"/> <formal value="A name associated with the person."/> <min value="0"/> <max value="1"/> <type> <code value="HumanName"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="name"/> </mapping> <mapping> <identity value="v2"/> <map value="NK1-2"/> </mapping> </definition> </element> <element> <path value="RelatedPerson.telecom"/> <definition> <short value="A contact detail for the person"/> <formal value="A contact detail for the person, e.g. a telephone number or an email address."/> <comments value="Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification."/> <min value="0"/> <max value="*"/> <type> <code value="Contact"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="telecom"/> </mapping> <mapping> <identity value="v2"/> <map value="NK1-5 / NK1-6 / NK1-40"/> </mapping> </definition> </element> <element> <path value="RelatedPerson.gender"/> <definition> <short value="Gender for administrative purposes"/> <formal value="Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="AdministrativeGender"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/administrative-gender"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="administrativeGender"/> </mapping> <mapping> <identity value="v2"/> <map value="NK1-15"/> </mapping> </definition> </element> <element> <path value="RelatedPerson.address"/> <definition> <short value="Address where the related person can be contacted or visited"/> <formal value="Address where the related person can be contacted or visited."/> <min value="0"/> <max value="1"/> <type> <code value="Address"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="addr"/> </mapping> <mapping> <identity value="v2"/> <map value="NK1-4"/> </mapping> </definition> </element> <element> <path value="RelatedPerson.photo"/> <definition> <short value="Image of the person"/> <formal value="Image of the person."/> <min value="0"/> <max value="*"/> <type> <code value="Attachment"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="player[classCode='PSN' and determinerCode='INSTANCE']/desc"/> </mapping> <mapping> <identity value="v2"/> <map value="OBX-5 - needs a profile"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="address"/> <type value="string"/> <documentation value="An address in any kind of address/part"/> <xpath value="f:RelatedPerson/f:address"/> </searchParam> <searchParam> <name value="gender"/> <type value="token"/> <documentation value="Gender of the person"/> <xpath value="f:RelatedPerson/f:gender"/> </searchParam> <searchParam> <name value="identifier"/> <type value="token"/> <documentation value="A patient Identifier"/> <xpath value="f:RelatedPerson/f:identifier"/> </searchParam> <searchParam> <name value="name"/> <type value="string"/> <documentation value="A portion of name in any name part"/> <xpath value="f:RelatedPerson/f:name"/> </searchParam> <searchParam> <name value="patient"/> <type value="reference"/> <documentation value="The patient this person is related to"/> <xpath value="f:RelatedPerson/f:patient"/> </searchParam> <searchParam> <name value="phonetic"/> <type value="string"/> <documentation value="A portion of name using some kind of phonetic matching algorithm"/> </searchParam> <searchParam> <name value="telecom"/> <type value="string"/> <documentation value="The value in any kind of contact"/> <xpath value="f:RelatedPerson/f:telecom"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="relatedperson-definitions.html#RelatedPerson" 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."><b>RelatedPerson</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="relatedperson-definitions.html#RelatedPerson.identifier" title="Identifier for a person within a particular scope."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></identifier> <<a class="dict" href="relatedperson-definitions.html#RelatedPerson.patient" title="The patient this person is related to."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></patient> <<a class="dict" href="relatedperson-definitions.html#RelatedPerson.relationship" title="The nature of the relationship between a patient and the related person."><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 href="valueset-relatedperson-relationshiptype.html" style="color: navy">The nature of the relationship<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></relationship> <<a class="dict" href="relatedperson-definitions.html#RelatedPerson.name" title="A name associated with the person."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></name> <<a class="dict" href="relatedperson-definitions.html#RelatedPerson.telecom" title="A contact detail for the person, e.g. a telephone number or an email address."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></telecom> <<a class="dict" href="relatedperson-definitions.html#RelatedPerson.gender" title="Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes."><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 href="valueset-administrative-gender.html" style="color: navy">Gender for administrative purposes<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --></span></gender> <<a class="dict" href="relatedperson-definitions.html#RelatedPerson.address" title="Address where the related person can be contacted or visited."><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 style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --></span></address> <<a class="dict" href="relatedperson-definitions.html#RelatedPerson.photo" title="Image of the person."><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> </RelatedPerson> </pre></div> </summary> </entry> <entry> <title>"securityevent" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/securityevent</id> <link href="http://hl7.org/implement/standards/fhir/securityevent.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="securityevent-definitions.html#SecurityEvent" 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."><b>SecurityEvent</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.event" title="Identifies the name, action type, time, and disposition of the audited event."><b>event</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>1..1</b></span> What was done --></span> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.event.type" title="Identifier for a family of the event."><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 href="valueset-security-event-type.html" style="color: navy">Type/identifier of event</a></span><span style="color: Gray"> --></span></type> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.event.subtype" title="Identifier for the category of event."><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 href="valueset-security-event-sub-type.html" style="color: navy">More specific type/id for the event</a></span><span style="color: Gray"> --></span></subtype> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.event.action" title="Indicator for type of action performed during the event that generated the audit."><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 href="security-event-action.html" style="color: navy">Type of action performed during the event</a></span><span style="color: Gray"> --></span> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.event.dateTime" title="The time when the event occurred on the source."><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> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.event.outcome" title="Indicates whether the event succeeded or failed."><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 href="security-event-outcome.html" style="color: navy">Whether the event succeeded or failed</a></span><span style="color: Gray"> --></span> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.event.outcomeDesc" title="A free text description of the outcome of the event."><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> </event> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.participant" title="A person, a hardware device or software process."><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> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.participant.role" 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."><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 href="valueset-dicm-402-roleid.html" style="color: navy">User roles (e.g. local RBAC codes)</a></span><span style="color: Gray"> --></span></role> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.participant.reference" title="Direct reference to a resource that identifies the participant."><b>reference</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-3: Either a userId or a reference, but not both"><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> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.participant.userId" title="Unique identifier for the user actively participating in the event."><b>userId</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-3: Either a userId or a reference, but not both"><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> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.participant.altId" 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."><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> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.participant.name" title="Human-meaningful name for the user."><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> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.participant.requestor" title="Indicator that the user is or is not the requestor, or initiator, for the event being audited."><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> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.participant.media" title="Type of media involved. Used when the event is about exporting/importing onto 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> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.participant.network" title="Logical network location for application activity, if the activity has a network location."><b>network</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..1</b></span> Logical network location for application activity --></span> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.participant.network.identifier" title="An identifier for the network access point of the user device for the audit event."><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> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.participant.network.type" title="An identifier for the type of network access point that originated the audit event."><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 href="network-type.html" style="color: navy">The type of network access point</a></span><span style="color: Gray"> --></span> </network> </participant> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.source" title="Application systems and processes."><b>source</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>1..1</b></span> Application systems and processes --></span> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.source.site" title="Logical source location within the healthcare enterprise network."><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> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.source.identifier" title="Identifier of the source where the event originated."><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> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.source.type" title="Code specifying the type of source where event originated."><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 href="valueset-security-source-type.html" style="color: navy">The type of source where event originated</a></span><span style="color: Gray"> --></span></type> </source> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.object" title="Specific instances of data or objects that have been accessed."><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> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.object.identifier" title="Identifies a specific instance of the participant object. The reference should always be version specific."><b>identifier</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-2: Either an identifier or a reference, but not both"><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> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.object.reference" title="Identifies a specific instance of the participant object. The reference should always be version specific."><b>reference</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-2: Either an identifier or a reference, but not both"><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> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.object.type" title="Object type being audited."><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 href="object-type.html" style="color: navy">Object type being audited</a></span><span style="color: Gray"> --></span> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.object.role" title="Code representing the functional application role of Participant Object being audited."><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 href="object-role.html" style="color: navy">Functional application role of Object</a></span><span style="color: Gray"> --></span> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.object.lifecycle" title="Identifier for the data life-cycle stage for the participant object."><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 href="object-lifecycle.html" style="color: navy">Life-cycle stage for the object</a></span><span style="color: Gray"> --></span> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.object.sensitivity" title="Denotes policy-defined sensitivity for the Participant Object ID such as VIP, HIV status, mental health status or similar topics."><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 href="valueset-security-event-sensitivity.html" style="color: navy">Policy-defined sensitivity for the object</a></span><span style="color: Gray"> --></span></sensitivity> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.object.name" title="An instance-specific descriptor of the Participant Object ID audited, such as a person's 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" title="Inv-1: Either a name or a query (or both)"><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> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.object.description" title="Text that describes the object in more detail."><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> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.object.query" title="The actual query for a query-type participant object."><b>query</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#base64Binary">base64Binary</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: Either a name or a query (or both)"><b><img alt="??" src="lock.png"/> 0..1</b></span> <span style="color: navy">Actual query for object</span><span style="color: Gray"> --></span> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.object.detail" title="Additional Information about the Object."><b>detail</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Additional Information about the Object --></span> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.object.detail.type" title="Name of the property."><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> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.object.detail.value" title="Property 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> </detail> </object> </SecurityEvent> </pre></div> </text> <name value="securityevent"/> <publisher value="FHIR Project"/> <description value="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 value="draft"/> <date value="2014-09-30"/> <requirements value="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. The 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 value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="dicom"/> <uri value="http://nema.org/dicom"/> <name value="DICOM"/> </mapping> <structure> <type value="SecurityEvent"/> <publish value="true"/> <element> <path value="SecurityEvent"/> <definition> <short value="Event record kept for security purposes"/> <formal value="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 value="Based on ATNA (RFC 3881)."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="ControlAct[moodCode=EVN]"/> </mapping> <mapping> <identity value="dicom"/> <map value="Message"/> </mapping> </definition> </element> <element> <path value="SecurityEvent.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="SecurityEvent.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="SecurityEvent.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="SecurityEvent.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="SecurityEvent.event"/> <definition> <short value="What was done"/> <formal value="Identifies the name, action type, time, and disposition of the audited event."/> <min value="1"/> <max value="1"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="N/A (no nesting in v3)"/> </mapping> <mapping> <identity value="dicom"/> <map value="EventIdentification"/> </mapping> </definition> </element> <element> <path value="SecurityEvent.event.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="SecurityEvent.event.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="SecurityEvent.event.type"/> <definition> <short value="Type/identifier of event"/> <formal value="Identifier for a family of the event."/> <comments value="e.g., a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="SecurityEventType"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/security-event-type"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".code (type, subtype and action are pre-coordinated or sent as translations)"/> </mapping> <mapping> <identity value="dicom"/> <map value="@EventId"/> </mapping> </definition> </element> <element> <path value="SecurityEvent.event.subtype"/> <definition> <short value="More specific type/id for the event"/> <formal value="Identifier for the category of event."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="SecurityEventSubType"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/security-event-sub-type"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".code (type, subtype and action are pre-coordinated or sent as translations)"/> </mapping> <mapping> <identity value="dicom"/> <map value="@EventTypeCode"/> </mapping> </definition> </element> <element> <path value="SecurityEvent.event.action"/> <definition> <short value="Type of action performed during the event"/> <formal value="Indicator for type of action performed during the event that generated the audit."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="SecurityEventAction"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/security-event-action"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".code (type, subtype and action are pre-coordinated or sent as translations)"/> </mapping> <mapping> <identity value="dicom"/> <map value="@EventActionCode"/> </mapping> </definition> </element> <element> <path value="SecurityEvent.event.dateTime"/> <definition> <short value="Time when the event occurred on source"/> <formal value="The time when the event occurred on the source."/> <comments value="In a distributed system, some sort of common time base, e.g., an NTP [RFC1305] server, is a good implementation tactic."/> <min value="1"/> <max value="1"/> <type> <code value="instant"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".effectiveTime"/> </mapping> <mapping> <identity value="dicom"/> <map value="@EventDateTime"/> </mapping> </definition> </element> <element> <path value="SecurityEvent.event.outcome"/> <definition> <short value="Whether the event succeeded or failed"/> <formal value="Indicates whether the event succeeded or failed."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="SecurityEventOutcome"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/security-event-outcome"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".actionNegationInd"/> </mapping> <mapping> <identity value="dicom"/> <map value="@EventOutcomeIndicator"/> </mapping> </definition> </element> <element> <path value="SecurityEvent.event.outcomeDesc"/> <definition> <short value="Description of the event outcome"/> <formal value="A free text description of the outcome of the event."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=OUT].target.text"/> </mapping> <mapping> <identity value="dicom"/> <map value="@EventOutcomeDescription"/> </mapping> </definition> </element> <element> <path value="SecurityEvent.participant"/> <definition> <short value="A person, a hardware device or software process"/> <formal value="A person, a hardware device or software process."/> <comments value="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 value="1"/> <max value="*"/> <constraint> <key value="3"/> <name value="Participant Identification"/> <severity value="error"/> <human value="Either a userId or a reference, but not both"/> <xpath value="exists(f:userId) != exists(f:reference)"/> </constraint> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation"/> </mapping> <mapping> <identity value="dicom"/> <map value="ActiveParticipant"/> </mapping> </definition> </element> <element> <path value="SecurityEvent.participant.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="SecurityEvent.participant.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="SecurityEvent.participant.role"/> <definition> <short value="User roles (e.g. local RBAC codes)"/> <formal value="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 value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="DICOMRoleId"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/dicm-402-roleid"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".typeCode and/or .functionCode"/> </mapping> <mapping> <identity value="dicom"/> <map value="RoleIdCode"/> </mapping> </definition> </element> <element> <path value="SecurityEvent.participant.reference"/> <definition> <short value="Direct reference to resource"/> <formal value="Direct reference to a resource that identifies the participant."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Device"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".role"/> </mapping> </definition> </element> <element> <path value="SecurityEvent.participant.userId"/> <definition> <short value="Unique identifier for the user"/> <formal value="Unique identifier for the user actively participating in the event."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> <mapping> <identity value="dicom"/> <map value="@UserId"/> </mapping> </definition> </element> <element> <path value="SecurityEvent.participant.altId"/> <definition> <short value="Alternative User id e.g. authentication"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id (distinguish id type by root)"/> </mapping> <mapping> <identity value="dicom"/> <map value="@AlternativeUserId"/> </mapping> </definition> </element> <element> <path value="SecurityEvent.participant.name"/> <definition> <short value="Human-meaningful name for the user"/> <formal value="Human-meaningful name for the user."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".name"/> </mapping> <mapping> <identity value="dicom"/> <map value="@UserName"/> </mapping> </definition> </element> <element> <path value="SecurityEvent.participant.requestor"/> <definition> <short value="Whether user is initiator"/> <formal value="Indicator that the user is or is not the requestor, or initiator, for the event being audited."/> <comments value="There can only be one initiator. If the initiator is not clear, then do not choose any one participant as the initiator."/> <min value="1"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="If participation.typeCode was author, then true"/> </mapping> <mapping> <identity value="dicom"/> <map value="@UserIsRequestor"/> </mapping> </definition> </element> <element> <path value="SecurityEvent.participant.media"/> <definition> <short value="Type of media"/> <formal value="Type of media involved. Used when the event is about exporting/importing onto media."/> <min value="0"/> <max value="1"/> <type> <code value="Coding"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".player.description.mediaType"/> </mapping> <mapping> <identity value="dicom"/> <map value="MediaType"/> </mapping> </definition> </element> <element> <path value="SecurityEvent.participant.network"/> <definition> <short value="Logical network location for application activity"/> <formal value="Logical network location for application activity, if the activity has a network location."/> <min value="0"/> <max value="1"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".player.description.reference"/> </mapping> </definition> </element> <element> <path value="SecurityEvent.participant.network.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="SecurityEvent.participant.network.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="SecurityEvent.participant.network.identifier"/> <definition> <short value="Identifier for the network access point of the user device"/> <formal value="An identifier for the network access point of the user device for the audit event."/> <comments value="This could be a device id, IP address or some other identifier associated with a device."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="pre-coordinated into URL"/> </mapping> <mapping> <identity value="dicom"/> <map value="@NetworkAccessPointID"/> </mapping> </definition> </element> <element> <path value="SecurityEvent.participant.network.type"/> <definition> <short value="The type of network access point"/> <formal value="An identifier for the type of network access point that originated the audit event."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="SecurityEventParticipantNetworkType"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/network-type"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="pre-coordinated into URL"/> </mapping> <mapping> <identity value="dicom"/> <map value="@NetworkAccessPointTypeCode"/> </mapping> </definition> </element> <element> <path value="SecurityEvent.source"/> <definition> <short value="Application systems and processes"/> <formal value="Application systems and processes."/> <comments value="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 value="1"/> <max value="1"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=INF].role[classCode=ASSIGN].player[classCode=DEV, determinerCode=INSTANCE]"/> </mapping> <mapping> <identity value="dicom"/> <map value="AuditSourceIdentification"/> </mapping> </definition> </element> <element> <path value="SecurityEvent.source.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="SecurityEvent.source.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="SecurityEvent.source.site"/> <definition> <short value="Logical source location within the enterprise"/> <formal value="Logical source location within the healthcare enterprise network."/> <comments value="a hospital or other provider location within a multi-entity provider group."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".scopedRole[classCode=LOCE].player.desc"/> </mapping> <mapping> <identity value="dicom"/> <map value="@AuditEnterpriseSiteId"/> </mapping> </definition> </element> <element> <path value="SecurityEvent.source.identifier"/> <definition> <short value="The id of source where event originated"/> <formal value="Identifier of the source where the event originated."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> <mapping> <identity value="dicom"/> <map value="@AuditSourceId"/> </mapping> </definition> </element> <element> <path value="SecurityEvent.source.type"/> <definition> <short value="The type of source where event originated"/> <formal value="Code specifying the type of source where event originated."/> <min value="0"/> <max value="*"/> <type> <code value="Coding"/> </type> <isModifier value="false"/> <binding> <name value="SecurityEventSourceType"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/security-source-type"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> <mapping> <identity value="dicom"/> <map value="AuditSourceTypeCode"/> </mapping> </definition> </element> <element> <path value="SecurityEvent.object"/> <definition> <short value="Specific instances of data or objects that have been accessed"/> <formal value="Specific instances of data or objects that have been accessed."/> <comments value="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 value="0"/> <max value="*"/> <constraint> <key value="2"/> <name value="Object Identification"/> <severity value="error"/> <human value="Either an identifier or a reference, but not both"/> <xpath value="exists(f:identifier) != exists(f:reference)"/> </constraint> <constraint> <key value="1"/> <name value="Object Name"/> <severity value="error"/> <human value="Either a name or a query (or both)"/> <xpath value="not(exists(f:name)) or not(exists(f:query))"/> </constraint> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=SUBJ].target or .participation[typeCode=SBJ].role"/> </mapping> <mapping> <identity value="dicom"/> <map value="ParticipantObjectIdentification"/> </mapping> </definition> </element> <element> <path value="SecurityEvent.object.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="SecurityEvent.object.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="SecurityEvent.object.identifier"/> <definition> <short value="Specific instance of object (e.g. versioned)"/> <formal value="Identifies a specific instance of the participant object. The reference should always be version specific."/> <comments value="Identifier details depends on object type."/> <min value="0"/> <max value="1"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id.extension"/> </mapping> <mapping> <identity value="dicom"/> <map value="@ParticipantObjectID"/> </mapping> </definition> </element> <element> <path value="SecurityEvent.object.reference"/> <definition> <short value="Specific instance of resource (e.g. versioned)"/> <formal value="Identifies a specific instance of the participant object. The reference should always be version specific."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Any"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="[self]"/> </mapping> <mapping> <identity value="dicom"/> <map value="@ParticipantObjectID"/> </mapping> </definition> </element> <element> <path value="SecurityEvent.object.type"/> <definition> <short value="Object type being audited"/> <formal value="Object type being audited."/> <comments value="This value is distinct from the user's role or any user relationship to the participant object."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="SecurityEventObjectType"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/object-type"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="[self::Act].code or role.player.code"/> </mapping> <mapping> <identity value="dicom"/> <map value="@ParticipantObjectTypeCode"/> </mapping> </definition> </element> <element> <path value="SecurityEvent.object.role"/> <definition> <short value="Functional application role of Object"/> <formal value="Code representing the functional application role of Participant Object being audited."/> <comments value="See RFC 3881 for rules concerning matches between role and type."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="SecurityEventObjectRole"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/object-role"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="role.code (not sure what this would mean for an Act)"/> </mapping> <mapping> <identity value="dicom"/> <map value="@ParticipantObjectTypeCodeRole"/> </mapping> </definition> </element> <element> <path value="SecurityEvent.object.lifecycle"/> <definition> <short value="Life-cycle stage for the object"/> <formal value="Identifier for the data life-cycle stage for the participant object."/> <comments value="This can be used to provide an audit trail for data, over time, as it passes through the system."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="SecurityEventObjectLifecycle"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/object-lifecycle"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="target of ObservationEvent[code="lifecycle"].value"/> </mapping> <mapping> <identity value="dicom"/> <map value="@ParticipantObjectDataLifeCycle"/> </mapping> </definition> </element> <element> <path value="SecurityEvent.object.sensitivity"/> <definition> <short value="Policy-defined sensitivity for the object"/> <formal value="Denotes policy-defined sensitivity for the Participant Object ID such as VIP, HIV status, mental health status or similar topics."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="SecurityEventObjectSensitivity"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/security-event-sensitivity"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".confidentialityCode"/> </mapping> <mapping> <identity value="dicom"/> <map value="@ParticipantObjectSensitivity"/> </mapping> </definition> </element> <element> <path value="SecurityEvent.object.name"/> <definition> <short value="Instance-specific descriptor for Object"/> <formal value="An instance-specific descriptor of the Participant Object ID audited, such as a person's name."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".title"/> </mapping> <mapping> <identity value="dicom"/> <map value="ParticipantObjectName"/> </mapping> </definition> </element> <element> <path value="SecurityEvent.object.description"/> <definition> <short value="Descriptive text"/> <formal value="Text that describes the object in more detail."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".text"/> </mapping> <mapping> <identity value="dicom"/> <map value="ParticipantObjectDescription"/> </mapping> </definition> </element> <element> <path value="SecurityEvent.object.query"/> <definition> <short value="Actual query for object"/> <formal value="The actual query for a query-type participant object."/> <min value="0"/> <max value="1"/> <type> <code value="base64Binary"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="No mapping"/> </mapping> <mapping> <identity value="dicom"/> <map value="ParticipantObjectQuery"/> </mapping> </definition> </element> <element> <path value="SecurityEvent.object.detail"/> <definition> <short value="Additional Information about the Object"/> <formal value="Additional Information about the Object."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN]"/> </mapping> <mapping> <identity value="dicom"/> <map value="ParticipantObjectDetail"/> </mapping> </definition> </element> <element> <path value="SecurityEvent.object.detail.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="SecurityEvent.object.detail.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="SecurityEvent.object.detail.type"/> <definition> <short value="Name of the property"/> <formal value="Name of the property."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> <mapping> <identity value="dicom"/> <map value="@type"/> </mapping> </definition> </element> <element> <path value="SecurityEvent.object.detail.value"/> <definition> <short value="Property value"/> <formal value="Property value."/> <min value="1"/> <max value="1"/> <type> <code value="base64Binary"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".value"/> </mapping> <mapping> <identity value="dicom"/> <map value="@value"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="action"/> <type value="token"/> <documentation value="Type of action performed during the event"/> <xpath value="f:SecurityEvent/f:event/f:action"/> </searchParam> <searchParam> <name value="address"/> <type value="token"/> <documentation value="Identifier for the network access point of the user device"/> <xpath value="f:SecurityEvent/f:participant/f:network/f:identifier"/> </searchParam> <searchParam> <name value="altid"/> <type value="token"/> <documentation value="Alternative User id e.g. authentication"/> <xpath value="f:SecurityEvent/f:participant/f:altId"/> </searchParam> <searchParam> <name value="date"/> <type value="date"/> <documentation value="Time when the event occurred on source"/> <xpath value="f:SecurityEvent/f:event/f:dateTime"/> </searchParam> <searchParam> <name value="desc"/> <type value="string"/> <documentation value="Instance-specific descriptor for Object"/> <xpath value="f:SecurityEvent/f:object/f:name"/> </searchParam> <searchParam> <name value="identity"/> <type value="token"/> <documentation value="Specific instance of object (e.g. versioned)"/> <xpath value="f:SecurityEvent/f:object/f:identifier"/> </searchParam> <searchParam> <name value="name"/> <type value="string"/> <documentation value="Human-meaningful name for the user"/> <xpath value="f:SecurityEvent/f:participant/f:name"/> </searchParam> <searchParam> <name value="object-type"/> <type value="token"/> <documentation value="Object type being audited"/> <xpath value="f:SecurityEvent/f:object/f:type"/> </searchParam> <searchParam> <name value="patientid"/> <type value="token"/> <documentation value="The id of the patient (one of multiple kinds of participations)"/> </searchParam> <searchParam> <name value="reference"/> <type value="reference"/> <documentation value="Specific instance of resource (e.g. versioned)"/> <xpath value="f:SecurityEvent/f:object/f:reference"/> </searchParam> <searchParam> <name value="site"/> <type value="token"/> <documentation value="Logical source location within the enterprise"/> <xpath value="f:SecurityEvent/f:source/f:site"/> </searchParam> <searchParam> <name value="source"/> <type value="token"/> <documentation value="The id of source where event originated"/> <xpath value="f:SecurityEvent/f:source/f:identifier"/> </searchParam> <searchParam> <name value="subtype"/> <type value="token"/> <documentation value="More specific type/id for the event"/> <xpath value="f:SecurityEvent/f:event/f:subtype"/> </searchParam> <searchParam> <name value="type"/> <type value="token"/> <documentation value="Type/identifier of event"/> <xpath value="f:SecurityEvent/f:event/f:type"/> </searchParam> <searchParam> <name value="user"/> <type value="token"/> <documentation value="Unique identifier for the user"/> <xpath value="f:SecurityEvent/f:participant/f:userId"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="securityevent-definitions.html#SecurityEvent" 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."><b>SecurityEvent</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.event" title="Identifies the name, action type, time, and disposition of the audited event."><b>event</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>1..1</b></span> What was done --></span> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.event.type" title="Identifier for a family of the event."><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 href="valueset-security-event-type.html" style="color: navy">Type/identifier of event</a></span><span style="color: Gray"> --></span></type> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.event.subtype" title="Identifier for the category of event."><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 href="valueset-security-event-sub-type.html" style="color: navy">More specific type/id for the event</a></span><span style="color: Gray"> --></span></subtype> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.event.action" title="Indicator for type of action performed during the event that generated the audit."><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 href="security-event-action.html" style="color: navy">Type of action performed during the event</a></span><span style="color: Gray"> --></span> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.event.dateTime" title="The time when the event occurred on the source."><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> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.event.outcome" title="Indicates whether the event succeeded or failed."><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 href="security-event-outcome.html" style="color: navy">Whether the event succeeded or failed</a></span><span style="color: Gray"> --></span> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.event.outcomeDesc" title="A free text description of the outcome of the event."><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> </event> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.participant" title="A person, a hardware device or software process."><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> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.participant.role" 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."><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 href="valueset-dicm-402-roleid.html" style="color: navy">User roles (e.g. local RBAC codes)</a></span><span style="color: Gray"> --></span></role> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.participant.reference" title="Direct reference to a resource that identifies the participant."><b>reference</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-3: Either a userId or a reference, but not both"><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> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.participant.userId" title="Unique identifier for the user actively participating in the event."><b>userId</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-3: Either a userId or a reference, but not both"><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> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.participant.altId" 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."><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> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.participant.name" title="Human-meaningful name for the user."><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> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.participant.requestor" title="Indicator that the user is or is not the requestor, or initiator, for the event being audited."><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> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.participant.media" title="Type of media involved. Used when the event is about exporting/importing onto 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> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.participant.network" title="Logical network location for application activity, if the activity has a network location."><b>network</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..1</b></span> Logical network location for application activity --></span> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.participant.network.identifier" title="An identifier for the network access point of the user device for the audit event."><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> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.participant.network.type" title="An identifier for the type of network access point that originated the audit event."><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 href="network-type.html" style="color: navy">The type of network access point</a></span><span style="color: Gray"> --></span> </network> </participant> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.source" title="Application systems and processes."><b>source</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>1..1</b></span> Application systems and processes --></span> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.source.site" title="Logical source location within the healthcare enterprise network."><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> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.source.identifier" title="Identifier of the source where the event originated."><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> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.source.type" title="Code specifying the type of source where event originated."><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 href="valueset-security-source-type.html" style="color: navy">The type of source where event originated</a></span><span style="color: Gray"> --></span></type> </source> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.object" title="Specific instances of data or objects that have been accessed."><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> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.object.identifier" title="Identifies a specific instance of the participant object. The reference should always be version specific."><b>identifier</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-2: Either an identifier or a reference, but not both"><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> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.object.reference" title="Identifies a specific instance of the participant object. The reference should always be version specific."><b>reference</b></a>><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-2: Either an identifier or a reference, but not both"><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> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.object.type" title="Object type being audited."><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 href="object-type.html" style="color: navy">Object type being audited</a></span><span style="color: Gray"> --></span> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.object.role" title="Code representing the functional application role of Participant Object being audited."><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 href="object-role.html" style="color: navy">Functional application role of Object</a></span><span style="color: Gray"> --></span> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.object.lifecycle" title="Identifier for the data life-cycle stage for the participant object."><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 href="object-lifecycle.html" style="color: navy">Life-cycle stage for the object</a></span><span style="color: Gray"> --></span> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.object.sensitivity" title="Denotes policy-defined sensitivity for the Participant Object ID such as VIP, HIV status, mental health status or similar topics."><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 href="valueset-security-event-sensitivity.html" style="color: navy">Policy-defined sensitivity for the object</a></span><span style="color: Gray"> --></span></sensitivity> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.object.name" title="An instance-specific descriptor of the Participant Object ID audited, such as a person's 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" title="Inv-1: Either a name or a query (or both)"><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> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.object.description" title="Text that describes the object in more detail."><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> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.object.query" title="The actual query for a query-type participant object."><b>query</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#base64Binary">base64Binary</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown" title="Inv-1: Either a name or a query (or both)"><b><img alt="??" src="lock.png"/> 0..1</b></span> <span style="color: navy">Actual query for object</span><span style="color: Gray"> --></span> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.object.detail" title="Additional Information about the Object."><b>detail</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Additional Information about the Object --></span> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.object.detail.type" title="Name of the property."><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> <<a class="dict" href="securityevent-definitions.html#SecurityEvent.object.detail.value" title="Property 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> </detail> </object> </SecurityEvent> </pre></div> </summary> </entry> <entry> <title>"specimen" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/specimen</id> <link href="http://hl7.org/implement/standards/fhir/specimen.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="specimen-definitions.html#Specimen" title="Sample for analysis."><b>Specimen</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="specimen-definitions.html#Specimen.identifier" title="Id for specimen."><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> <<a class="dict" href="specimen-definitions.html#Specimen.type" title="Kind of material that forms the specimen."><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 href="v2/0487/index.html" style="color: navy">Kind of material that forms the specimen</a><span style="color: Gray"> --></span></type> <<a class="dict" href="specimen-definitions.html#Specimen.source" title="Parent specimen from which the focal specimen was a component."><b>source</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Parent of specimen --></span> <<a class="dict" href="specimen-definitions.html#Specimen.source.relationship" title="Whether this relationship is to a parent or to a child."><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 href="hierarchical-relationship-type.html" style="color: navy">parent | child</a></span><span style="color: Gray"> --></span> <<a class="dict" href="specimen-definitions.html#Specimen.source.target" title="The specimen resource that is the target of this relationship."><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> </source> <<a class="dict" href="specimen-definitions.html#Specimen.subject" title="Where the specimen came from. This may be the patient(s) or from the environment or a device."><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"> 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> <<a class="dict" href="specimen-definitions.html#Specimen.accessionIdentifier" 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."><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> <<a class="dict" href="specimen-definitions.html#Specimen.receivedTime" title="Time when specimen was received for processing or testing."><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> <<a class="dict" href="specimen-definitions.html#Specimen.collection" title="Details concerning the specimen collection."><b>collection</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>1..1</b></span> Collection details --></span> <<a class="dict" href="specimen-definitions.html#Specimen.collection.collector" title="Person who collected the specimen."><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> <<a class="dict" href="specimen-definitions.html#Specimen.collection.comment" title="To communicate any details or issues encountered during the specimen collection procedure."><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> <<a class="dict" href="specimen-definitions.html#Specimen.collection.collected_x_" title="Time when specimen was collected from subject - the physiologically relevant time."><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]> <<a class="dict" href="specimen-definitions.html#Specimen.collection.quantity" title="The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample."><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> <<a class="dict" href="specimen-definitions.html#Specimen.collection.method" title="A coded value specifying the technique that is used to perform the procedure."><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 href="valueset-specimen-collection-method.html" style="color: navy">Technique used to perform collection</a></span><span style="color: Gray"> --></span></method> <<a class="dict" href="specimen-definitions.html#Specimen.collection.sourceSite" title="Anatomical location from which the specimen should be collected (if subject is a patient). This element is not used for environmental specimens."><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 href="valueset-body-site.html" style="color: navy">Anatomical collection site</a></span><span style="color: Gray"> --></span></sourceSite> </collection> <<a class="dict" href="specimen-definitions.html#Specimen.treatment" title="Details concerning treatment and processing steps for the specimen."><b>treatment</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Treatment and processing step details --></span> <<a class="dict" href="specimen-definitions.html#Specimen.treatment.description" title="Textual description of procedure."><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> <<a class="dict" href="specimen-definitions.html#Specimen.treatment.procedure" title="A coded value specifying the procedure used to process the specimen."><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 href="valueset-specimen-treatment-procedure.html" style="color: navy">Indicates the treatment or processing step applied to the specimen</a></span><span style="color: Gray"> --></span></procedure> <<a class="dict" href="specimen-definitions.html#Specimen.treatment.additive" title="Material used in the processing step."><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> </treatment> <<a class="dict" href="specimen-definitions.html#Specimen.container" title="The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here."><b>container</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Direct container of specimen (tube/slide, etc) --></span> <<a class="dict" href="specimen-definitions.html#Specimen.container.identifier" 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."><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> <<a class="dict" href="specimen-definitions.html#Specimen.container.description" title="Textual description of the container."><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> <<a class="dict" href="specimen-definitions.html#Specimen.container.type" title="The type of container associated with the specimen (e.g. slide, aliquot, etc)."><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 href="valueset-specimen-container-type.html" style="color: navy">Kind of container directly associated with specimen</a></span><span style="color: Gray"> --></span></type> <<a class="dict" href="specimen-definitions.html#Specimen.container.capacity" title="The capacity (volume or other measure) the container may contain."><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> <<a class="dict" href="specimen-definitions.html#Specimen.container.specimenQuantity" title="The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type."><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> <<a class="dict" href="specimen-definitions.html#Specimen.container.additive" title="Additive associated with the container."><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> </container> </Specimen> </pre></div> </text> <name value="specimen"/> <publisher value="FHIR Project"/> <description value="Basic Profile. Sample for analysis."/> <status value="draft"/> <date value="2014-09-30"/> <requirements value="Scope and Usage Any material sample: * taken from a biological entity, living or dead * taken from a physical object or the environment Biospecimen 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). The 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 value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <structure> <type value="Specimen"/> <publish value="true"/> <element> <path value="Specimen"/> <definition> <short value="Sample for analysis"/> <formal value="Sample for analysis."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Role[classCode=SPEC]"/> </mapping> </definition> </element> <element> <path value="Specimen.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Specimen.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Specimen.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Specimen.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Specimen.identifier"/> <definition> <short value="External Identifier"/> <formal value="Id for specimen."/> <min value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> <mapping> <identity value="v2"/> <map value="SPM-2"/> </mapping> </definition> </element> <element> <path value="Specimen.type"/> <definition> <short value="Kind of material that forms the specimen"/> <formal value="Kind of material that forms the specimen."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="SpecimenType"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/v2/vs/0487"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> <mapping> <identity value="v2"/> <map value="SPM-4 and possibly SPM-5"/> </mapping> </definition> </element> <element> <path value="Specimen.source"/> <definition> <short value="Parent of specimen"/> <formal value="Parent specimen from which the focal specimen was a component."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".scoper (if parent) .player.scopesRole[classCode=SPEC].player (if child)"/> </mapping> </definition> </element> <element> <path value="Specimen.source.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Specimen.source.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Specimen.source.relationship"/> <definition> <short value="parent | child"/> <formal value="Whether this relationship is to a parent or to a child."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="HierarchicalRelationshipType"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/hierarchical-relationship-type"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="as above"/> </mapping> <mapping> <identity value="v2"/> <map value="not explicit in v2.x SPM segment, but can be derived as child,if SPM-3 Specimen parent ID is filled in"/> </mapping> </definition> </element> <element> <path value="Specimen.source.target"/> <definition> <short value="The subject of the relationship"/> <formal value="The specimen resource that is the target of this relationship."/> <min value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Specimen"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="[self]"/> </mapping> </definition> </element> <element> <path value="Specimen.subject"/> <definition> <short value="Where the specimen came from. This may be the patient(s) or from the environment or a device"/> <formal value="Where the specimen came from. This may be the patient(s) or from the environment or a device."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Group"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Device"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Substance"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".scoper or .scoper.playsRole"/> </mapping> </definition> </element> <element> <path value="Specimen.accessionIdentifier"/> <definition> <short value="Identifier assigned by the lab"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=SBJ].act[classCode=ACSN, moodCode=EVN].id"/> </mapping> <mapping> <identity value="v2"/> <map value="SPM-30 (v2.7+)"/> </mapping> </definition> </element> <element> <path value="Specimen.receivedTime"/> <definition> <short value="The time when specimen was received for processing"/> <formal value="Time when specimen was received for processing or testing."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=SBJ].act[code=SPCREC, moodCode=EVN].effectiveTime"/> </mapping> <mapping> <identity value="v2"/> <map value="SPM-18"/> </mapping> </definition> </element> <element> <path value="Specimen.collection"/> <definition> <short value="Collection details"/> <formal value="Details concerning the specimen collection."/> <min value="1"/> <max value="1"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=SBJ].act[classCode=SPECCOLLECT, moodCode=EVN]"/> </mapping> </definition> </element> <element> <path value="Specimen.collection.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Specimen.collection.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Specimen.collection.collector"/> <definition> <short value="Who collected the specimen"/> <formal value="Person who collected the specimen."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=PFM].role"/> </mapping> </definition> </element> <element> <path value="Specimen.collection.comment"/> <definition> <short value="Collector comments"/> <formal value="To communicate any details or issues encountered during the specimen collection procedure."/> <min value="0"/> <max value="*"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="annotation"] .value"/> </mapping> </definition> </element> <element> <path value="Specimen.collection.collected[x]"/> <definition> <short value="Collection time"/> <formal value="Time when specimen was collected from subject - the physiologically relevant time."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <type> <code value="Period"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".effectiveTime"/> </mapping> <mapping> <identity value="v2"/> <map value="SPM-17"/> </mapping> </definition> </element> <element> <path value="Specimen.collection.quantity"/> <definition> <short value="The quantity of specimen collected"/> <formal value="The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample."/> <min value="0"/> <max value="1"/> <type> <code value="Quantity"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=SBJ].role[classCode=SPEC].player.quantity"/> </mapping> <mapping> <identity value="v2"/> <map value="SPM-12"/> </mapping> </definition> </element> <element> <path value="Specimen.collection.method"/> <definition> <short value="Technique used to perform collection"/> <formal value="A coded value specifying the technique that is used to perform the procedure."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="SpecimenCollectionMethod"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/specimen-collection-method"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".methodCode"/> </mapping> <mapping> <identity value="v2"/> <map value="SPM-7"/> </mapping> </definition> </element> <element> <path value="Specimen.collection.sourceSite"/> <definition> <short value="Anatomical collection site"/> <formal value="Anatomical location from which the specimen should be collected (if subject is a patient). This element is not used for environmental specimens."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="BodySite"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/body-site"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".approachSiteCode"/> </mapping> <mapping> <identity value="v2"/> <map value="SPM-8 and SPM-9"/> </mapping> </definition> </element> <element> <path value="Specimen.treatment"/> <definition> <short value="Treatment and processing step details"/> <formal value="Details concerning treatment and processing steps for the specimen."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=SBJ].act[code=SPCTRT, moodCode=EVN]"/> </mapping> </definition> </element> <element> <path value="Specimen.treatment.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Specimen.treatment.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Specimen.treatment.description"/> <definition> <short value="Textual description of procedure"/> <formal value="Textual description of procedure."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".text"/> </mapping> </definition> </element> <element> <path value="Specimen.treatment.procedure"/> <definition> <short value="Indicates the treatment or processing step applied to the specimen"/> <formal value="A coded value specifying the procedure used to process the specimen."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="SpecimenTreatmentProcedure"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/specimen-treatment-procedure"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> </definition> </element> <element> <path value="Specimen.treatment.additive"/> <definition> <short value="Material used in the processing step"/> <formal value="Material used in the processing step."/> <min value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Substance"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=CSM].role[classCode=ADTV].code"/> </mapping> <mapping> <identity value="v2"/> <map value="SPM-6"/> </mapping> </definition> </element> <element> <path value="Specimen.container"/> <definition> <short value="Direct container of specimen (tube/slide, etc)"/> <formal value="The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".player.scopingRole[classCode=CONT].scoper"/> </mapping> </definition> </element> <element> <path value="Specimen.container.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Specimen.container.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Specimen.container.identifier"/> <definition> <short value="Id for the container"/> <formal value="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 value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> <mapping> <identity value="v2"/> <map value="SAC-3"/> </mapping> </definition> </element> <element> <path value="Specimen.container.description"/> <definition> <short value="Textual description of the container"/> <formal value="Textual description of the container."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".desc"/> </mapping> </definition> </element> <element> <path value="Specimen.container.type"/> <definition> <short value="Kind of container directly associated with specimen"/> <formal value="The type of container associated with the specimen (e.g. slide, aliquot, etc)."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="SpecimenContainerType"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/specimen-container-type"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> <mapping> <identity value="v2"/> <map value="SPM-27"/> </mapping> </definition> </element> <element> <path value="Specimen.container.capacity"/> <definition> <short value="Container volume or size"/> <formal value="The capacity (volume or other measure) the container may contain."/> <min value="0"/> <max value="1"/> <type> <code value="Quantity"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".quantity"/> </mapping> <mapping> <identity value="v2"/> <map value="one of: SAC 16, SAC17 and SAC 20, or SAC 21 and SAC 20"/> </mapping> </definition> </element> <element> <path value="Specimen.container.specimenQuantity"/> <definition> <short value="Quantity of specimen within container"/> <formal value="The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type."/> <min value="0"/> <max value="1"/> <type> <code value="Quantity"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".playedRole[classCode=CONT].quantity"/> </mapping> <mapping> <identity value="v2"/> <map value="SAC-23 (value) SAC-24 (units"/> </mapping> </definition> </element> <element> <path value="Specimen.container.additive"/> <definition> <short value="Additive associated with container"/> <formal value="Additive associated with the container."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Substance"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".scopesRole[classCode=ADTV].player"/> </mapping> <mapping> <identity value="v2"/> <map value="SAC-27"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="subject"/> <type value="reference"/> <documentation value="The subject of the specimen"/> <xpath value="f:Specimen/f:subject"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="specimen-definitions.html#Specimen" title="Sample for analysis."><b>Specimen</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="specimen-definitions.html#Specimen.identifier" title="Id for specimen."><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> <<a class="dict" href="specimen-definitions.html#Specimen.type" title="Kind of material that forms the specimen."><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 href="v2/0487/index.html" style="color: navy">Kind of material that forms the specimen</a><span style="color: Gray"> --></span></type> <<a class="dict" href="specimen-definitions.html#Specimen.source" title="Parent specimen from which the focal specimen was a component."><b>source</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Parent of specimen --></span> <<a class="dict" href="specimen-definitions.html#Specimen.source.relationship" title="Whether this relationship is to a parent or to a child."><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 href="hierarchical-relationship-type.html" style="color: navy">parent | child</a></span><span style="color: Gray"> --></span> <<a class="dict" href="specimen-definitions.html#Specimen.source.target" title="The specimen resource that is the target of this relationship."><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> </source> <<a class="dict" href="specimen-definitions.html#Specimen.subject" title="Where the specimen came from. This may be the patient(s) or from the environment or a device."><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"> 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> <<a class="dict" href="specimen-definitions.html#Specimen.accessionIdentifier" 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."><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> <<a class="dict" href="specimen-definitions.html#Specimen.receivedTime" title="Time when specimen was received for processing or testing."><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> <<a class="dict" href="specimen-definitions.html#Specimen.collection" title="Details concerning the specimen collection."><b>collection</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>1..1</b></span> Collection details --></span> <<a class="dict" href="specimen-definitions.html#Specimen.collection.collector" title="Person who collected the specimen."><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> <<a class="dict" href="specimen-definitions.html#Specimen.collection.comment" title="To communicate any details or issues encountered during the specimen collection procedure."><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> <<a class="dict" href="specimen-definitions.html#Specimen.collection.collected_x_" title="Time when specimen was collected from subject - the physiologically relevant time."><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]> <<a class="dict" href="specimen-definitions.html#Specimen.collection.quantity" title="The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample."><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> <<a class="dict" href="specimen-definitions.html#Specimen.collection.method" title="A coded value specifying the technique that is used to perform the procedure."><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 href="valueset-specimen-collection-method.html" style="color: navy">Technique used to perform collection</a></span><span style="color: Gray"> --></span></method> <<a class="dict" href="specimen-definitions.html#Specimen.collection.sourceSite" title="Anatomical location from which the specimen should be collected (if subject is a patient). This element is not used for environmental specimens."><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 href="valueset-body-site.html" style="color: navy">Anatomical collection site</a></span><span style="color: Gray"> --></span></sourceSite> </collection> <<a class="dict" href="specimen-definitions.html#Specimen.treatment" title="Details concerning treatment and processing steps for the specimen."><b>treatment</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Treatment and processing step details --></span> <<a class="dict" href="specimen-definitions.html#Specimen.treatment.description" title="Textual description of procedure."><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> <<a class="dict" href="specimen-definitions.html#Specimen.treatment.procedure" title="A coded value specifying the procedure used to process the specimen."><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 href="valueset-specimen-treatment-procedure.html" style="color: navy">Indicates the treatment or processing step applied to the specimen</a></span><span style="color: Gray"> --></span></procedure> <<a class="dict" href="specimen-definitions.html#Specimen.treatment.additive" title="Material used in the processing step."><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> </treatment> <<a class="dict" href="specimen-definitions.html#Specimen.container" title="The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here."><b>container</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Direct container of specimen (tube/slide, etc) --></span> <<a class="dict" href="specimen-definitions.html#Specimen.container.identifier" 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."><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> <<a class="dict" href="specimen-definitions.html#Specimen.container.description" title="Textual description of the container."><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> <<a class="dict" href="specimen-definitions.html#Specimen.container.type" title="The type of container associated with the specimen (e.g. slide, aliquot, etc)."><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 href="valueset-specimen-container-type.html" style="color: navy">Kind of container directly associated with specimen</a></span><span style="color: Gray"> --></span></type> <<a class="dict" href="specimen-definitions.html#Specimen.container.capacity" title="The capacity (volume or other measure) the container may contain."><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> <<a class="dict" href="specimen-definitions.html#Specimen.container.specimenQuantity" title="The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type."><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> <<a class="dict" href="specimen-definitions.html#Specimen.container.additive" title="Additive associated with the container."><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> </container> </Specimen> </pre></div> </summary> </entry> <entry> <title>"substance" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/substance</id> <link href="http://hl7.org/implement/standards/fhir/substance.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="substance-definitions.html#Substance" title="A homogeneous material with a definite composition."><b>Substance</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="substance-definitions.html#Substance.type" title="A code (or set of codes) that identify this substance."><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 href="valueset-substance-type.html" style="color: navy">What kind of substance this is</a></span><span style="color: Gray"> --></span></type> <<a class="dict" href="substance-definitions.html#Substance.description" title="A description of the substance - its appearance, handling requirements, and other usage notes."><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> <<a class="dict" href="substance-definitions.html#Substance.instance" title="Substance may be used to describe a kind of substance, or a specific package/container of the substance: an 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> <<a class="dict" href="substance-definitions.html#Substance.instance.identifier" title="Identifier associated with the package/container (usually a label affixed directly)."><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> <<a class="dict" href="substance-definitions.html#Substance.instance.expiry" title="When the substance is no longer valid to use. For some substances, a single arbitrary date is used for 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> <<a class="dict" href="substance-definitions.html#Substance.instance.quantity" title="The amount of the substance."><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> </instance> <<a class="dict" href="substance-definitions.html#Substance.ingredient" title="A substance can be composed of other substances."><b>ingredient</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Composition information about the substance --></span> <<a class="dict" href="substance-definitions.html#Substance.ingredient.quantity" title="The amount of the ingredient in the substance - a concentration ratio."><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> <<a class="dict" href="substance-definitions.html#Substance.ingredient.substance" title="Another substance that is a component of this 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> </ingredient> </Substance> </pre></div> </text> <name value="substance"/> <publisher value="FHIR Project"/> <description value="Basic Profile. A homogeneous material with a definite composition."/> <status value="draft"/> <date value="2014-09-30"/> <requirements value="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). The composition of the material can be specified in terms of a mix of other materials, including with precise amounts if required."/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <structure> <type value="Substance"/> <publish value="true"/> <element> <path value="Substance"/> <definition> <short value="A homogeneous material with a definite composition"/> <formal value="A homogeneous material with a definite composition."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Material"/> </mapping> </definition> </element> <element> <path value="Substance.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Substance.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Substance.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Substance.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Substance.type"/> <definition> <short value="What kind of substance this is"/> <formal value="A code (or set of codes) that identify this substance."/> <comments value="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 value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="SubstanceType"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/substance-type"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> </definition> </element> <element> <path value="Substance.description"/> <definition> <short value="Textual description of the substance, comments"/> <formal value="A description of the substance - its appearance, handling requirements, and other usage notes."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".player.desc"/> </mapping> </definition> </element> <element> <path value="Substance.instance"/> <definition> <short value="If this describes a specific package/container of the substance"/> <formal value="Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance."/> <min value="0"/> <max value="1"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".player.determinerCode"/> </mapping> </definition> </element> <element> <path value="Substance.instance.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Substance.instance.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Substance.instance.identifier"/> <definition> <short value="Identifier of the package/container"/> <formal value="Identifier associated with the package/container (usually a label affixed directly)."/> <min value="0"/> <max value="1"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> </definition> </element> <element> <path value="Substance.instance.expiry"/> <definition> <short value="When no longer valid to use"/> <formal value="When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".expiryTime"/> </mapping> </definition> </element> <element> <path value="Substance.instance.quantity"/> <definition> <short value="Amount of substance in the package"/> <formal value="The amount of the substance."/> <min value="0"/> <max value="1"/> <type> <code value="Quantity"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".player.quantity"/> </mapping> </definition> </element> <element> <path value="Substance.ingredient"/> <definition> <short value="Composition information about the substance"/> <formal value="A substance can be composed of other substances."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".player.scopesRole[classCode=INGR]"/> </mapping> </definition> </element> <element> <path value="Substance.ingredient.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Substance.ingredient.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Substance.ingredient.quantity"/> <definition> <short value="Optional amount (concentration)"/> <formal value="The amount of the ingredient in the substance - a concentration ratio."/> <min value="0"/> <max value="1"/> <type> <code value="Ratio"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".quantity"/> </mapping> </definition> </element> <element> <path value="Substance.ingredient.substance"/> <definition> <short value="A component of the substance"/> <formal value="Another substance that is a component of this substance."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Substance"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".player"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="expiry"/> <type value="date"/> <documentation value="When no longer valid to use"/> <xpath value="f:Substance/f:instance/f:expiry"/> </searchParam> <searchParam> <name value="identifier"/> <type value="token"/> <documentation value="Identifier of the package/container"/> <xpath value="f:Substance/f:instance/f:identifier"/> </searchParam> <searchParam> <name value="quantity"/> <type value="number"/> <documentation value="Amount of substance in the package"/> <xpath value="f:Substance/f:instance/f:quantity"/> </searchParam> <searchParam> <name value="substance"/> <type value="reference"/> <documentation value="A component of the substance"/> <xpath value="f:Substance/f:ingredient/f:substance"/> </searchParam> <searchParam> <name value="type"/> <type value="token"/> <documentation value="The type of the substance"/> <xpath value="f:Substance/f:type"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="substance-definitions.html#Substance" title="A homogeneous material with a definite composition."><b>Substance</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="substance-definitions.html#Substance.type" title="A code (or set of codes) that identify this substance."><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 href="valueset-substance-type.html" style="color: navy">What kind of substance this is</a></span><span style="color: Gray"> --></span></type> <<a class="dict" href="substance-definitions.html#Substance.description" title="A description of the substance - its appearance, handling requirements, and other usage notes."><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> <<a class="dict" href="substance-definitions.html#Substance.instance" title="Substance may be used to describe a kind of substance, or a specific package/container of the substance: an 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> <<a class="dict" href="substance-definitions.html#Substance.instance.identifier" title="Identifier associated with the package/container (usually a label affixed directly)."><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> <<a class="dict" href="substance-definitions.html#Substance.instance.expiry" title="When the substance is no longer valid to use. For some substances, a single arbitrary date is used for 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> <<a class="dict" href="substance-definitions.html#Substance.instance.quantity" title="The amount of the substance."><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> </instance> <<a class="dict" href="substance-definitions.html#Substance.ingredient" title="A substance can be composed of other substances."><b>ingredient</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Composition information about the substance --></span> <<a class="dict" href="substance-definitions.html#Substance.ingredient.quantity" title="The amount of the ingredient in the substance - a concentration ratio."><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> <<a class="dict" href="substance-definitions.html#Substance.ingredient.substance" title="Another substance that is a component of this 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> </ingredient> </Substance> </pre></div> </summary> </entry> <entry> <title>"supply" as a profile (to help derivation)</title> <id>http://hl7.org/fhir/profile/supply</id> <link href="http://hl7.org/implement/standards/fhir/supply.profile.xml" rel="self"/> <updated>2014-09-30T18:08:29.499+10:00</updated> <author> <name>HL7, Inc (FHIR Project)</name> <uri>http://hl7.org/fhir</uri> </author> <published>2014-09-30T18:08:29.499+10:00</published> <content type="text/xml"> <Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="supply-definitions.html#Supply" title="A supply - a request for something, and provision of what is supplied."><b>Supply</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="supply-definitions.html#Supply.kind" title="Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process."><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 href="valueset-supply-type.html" style="color: navy">The kind of supply (central, non-stock, etc)</a></span><span style="color: Gray"> --></span></kind> <<a class="dict" href="supply-definitions.html#Supply.identifier" title="Unique identifier for this supply request."><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> <<a class="dict" href="supply-definitions.html#Supply.status" title="Status of the supply request."><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 href="valueset-supply-status.html" style="color: navy">requested | dispensed | received | failed | cancelled</a></span><span style="color: Gray"> --></span> <<a class="dict" href="supply-definitions.html#Supply.orderedItem" title="The item that is requested to be supplied."><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"> Medication, Substance, or Device requested to be supplied</span><span style="color: Gray"> --></span></orderedItem> <<a class="dict" href="supply-definitions.html#Supply.patient" title="A link to a resource representing the person whom the ordered item is for."><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> <<a class="dict" href="supply-definitions.html#Supply.dispense" title="Indicates the details of the dispense event such as the days supply and quantity of a supply dispensed."><b>dispense</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Supply details --></span> <<a class="dict" href="supply-definitions.html#Supply.dispense.identifier" title="Identifier assigned by the dispensing facility when the dispense occurs."><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> <<a class="dict" href="supply-definitions.html#Supply.dispense.status" title="A code specifying the state of the dispense event (this element modifies the meaning of other elements)"><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 href="valueset-supply-dispense-status.html" style="color: navy">in progress | dispensed | abandoned</a></span><span style="color: Gray"> --></span> <<a class="dict" href="supply-definitions.html#Supply.dispense.type" title="Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc."><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 href="valueset-supply-item.html" style="color: navy">Category of dispense event</a></span><span style="color: Gray"> --></span></type> <<a class="dict" href="supply-definitions.html#Supply.dispense.quantity" title="The amount of supply that has been dispensed. Includes unit of measure."><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> <<a class="dict" href="supply-definitions.html#Supply.dispense.suppliedItem" 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."><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"> Medication, Substance, or Device supplied</span><span style="color: Gray"> --></span></suppliedItem> <<a class="dict" href="supply-definitions.html#Supply.dispense.supplier" title="The individual responsible for dispensing the medication."><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> <<a class="dict" href="supply-definitions.html#Supply.dispense.whenPrepared" title="The time the dispense event occurred."><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> <<a class="dict" href="supply-definitions.html#Supply.dispense.whenHandedOver" title="The time the dispensed item was sent or handed to the patient (or agent)."><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> <<a class="dict" href="supply-definitions.html#Supply.dispense.destination" title="Identification of the facility/location where the Supply was shipped to, as part of the dispense event."><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> <<a class="dict" href="supply-definitions.html#Supply.dispense.receiver" title="Identifies the person who picked up the Supply."><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> </dispense> </Supply> </pre></div> </text> <name value="supply"/> <publisher value="FHIR Project"/> <description value="Basic Profile. A supply - a request for something, and provision of what is supplied."/> <status value="draft"/> <date value="2014-09-30"/> <requirements value="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 value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <structure> <type value="Supply"/> <publish value="true"/> <element> <path value="Supply"/> <definition> <short value="A supply - request and provision"/> <formal value="A supply - a request for something, and provision of what is supplied."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Supply[moodCode=RQO]"/> </mapping> </definition> </element> <element> <path value="Supply.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Supply.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Supply.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Supply.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Supply.kind"/> <definition> <short value="The kind of supply (central, non-stock, etc)"/> <formal value="Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="SupplyType"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/supply-type"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> </definition> </element> <element> <path value="Supply.identifier"/> <definition> <short value="Unique identifier"/> <formal value="Unique identifier for this supply request."/> <comments value="This is assigned by the orderer, and used to refer to this order in other external standards."/> <min value="0"/> <max value="1"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> </definition> </element> <element> <path value="Supply.status"/> <definition> <short value="requested | dispensed | received | failed | cancelled"/> <formal value="Status of the supply request."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="SupplyStatus"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/valueset-supply-status"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".statusCode, also existence of fulfillment events"/> </mapping> </definition> </element> <element> <path value="Supply.orderedItem"/> <definition> <short value="Medication, Substance, or Device requested to be supplied"/> <formal value="The item that is requested to be supplied."/> <comments value="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 value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Medication"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Substance"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Device"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=PRD].role"/> </mapping> </definition> </element> <element> <path value="Supply.patient"/> <definition> <short value="Patient for whom the item is supplied"/> <formal value="A link to a resource representing the person whom the ordered item is for."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=SBJ].role"/> </mapping> </definition> </element> <element> <path value="Supply.dispense"/> <definition> <short value="Supply details"/> <formal value="Indicates the details of the dispense event such as the days supply and quantity of a supply dispensed."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=FLFS].source[classCode=SPLY, moodCode=EVN]"/> </mapping> </definition> </element> <element> <path value="Supply.dispense.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Supply.dispense.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Supply.dispense.identifier"/> <definition> <short value="External identifier"/> <formal value="Identifier assigned by the dispensing facility when the dispense occurs."/> <comments value="This is assigned by the dispenser, and used to refer to this order in other external standards."/> <min value="0"/> <max value="1"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> </definition> </element> <element> <path value="Supply.dispense.status"/> <definition> <short value="in progress | dispensed | abandoned"/> <formal value="A code specifying the state of the dispense event."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="SupplyDispenseStatus"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/valueset-supply-dispense-status"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".statusCode, also existence of fulfillment events"/> </mapping> </definition> </element> <element> <path value="Supply.dispense.type"/> <definition> <short value="Category of dispense event"/> <formal value="Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="SupplyItemType"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/supply-item"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> </definition> </element> <element> <path value="Supply.dispense.quantity"/> <definition> <short value="Amount dispensed"/> <formal value="The amount of supply that has been dispensed. Includes unit of measure."/> <min value="0"/> <max value="1"/> <type> <code value="Quantity"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".quantity"/> </mapping> </definition> </element> <element> <path value="Supply.dispense.suppliedItem"/> <definition> <short value="Medication, Substance, or Device supplied"/> <formal value="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 value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Medication"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Substance"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Device"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=PRD].role"/> </mapping> </definition> </element> <element> <path value="Supply.dispense.supplier"/> <definition> <short value="Dispenser"/> <formal value="The individual responsible for dispensing the medication."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=PFM].role"/> </mapping> </definition> </element> <element> <path value="Supply.dispense.whenPrepared"/> <definition> <short value="Dispensing time"/> <formal value="The time the dispense event occurred."/> <min value="0"/> <max value="1"/> <type> <code value="Period"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".effectiveTime.low"/> </mapping> </definition> </element> <element> <path value="Supply.dispense.whenHandedOver"/> <definition> <short value="Handover time"/> <formal value="The time the dispensed item was sent or handed to the patient (or agent)."/> <min value="0"/> <max value="1"/> <type> <code value="Period"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".effectiveTime.high"/> </mapping> </definition> </element> <element> <path value="Supply.dispense.destination"/> <definition> <short value="Where the Supply was sent"/> <formal value="Identification of the facility/location where the Supply was shipped to, as part of the dispense event."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Location"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=DST].role"/> </mapping> </definition> </element> <element> <path value="Supply.dispense.receiver"/> <definition> <short value="Who collected the Supply"/> <formal value="Identifies the person who picked up the Supply."/> <min value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=RCV].role"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="dispenseid"/> <type value="token"/> <documentation value="External identifier"/> <xpath value="f:Supply/f:dispense/f:identifier"/> </searchParam> <searchParam> <name value="dispensestatus"/> <type value="token"/> <documentation value="in progress | dispensed | abandoned"/> <xpath value="f:Supply/f:dispense/f:status"/> </searchParam> <searchParam> <name value="identifier"/> <type value="token"/> <documentation value="Unique identifier"/> <xpath value="f:Supply/f:identifier"/> </searchParam> <searchParam> <name value="kind"/> <type value="token"/> <documentation value="The kind of supply (central, non-stock, etc)"/> <xpath value="f:Supply/f:kind"/> </searchParam> <searchParam> <name value="patient"/> <type value="reference"/> <documentation value="Patient for whom the item is supplied"/> <xpath value="f:Supply/f:patient"/> </searchParam> <searchParam> <name value="status"/> <type value="token"/> <documentation value="requested | dispensed | received | failed | cancelled"/> <xpath value="f:Supply/f:status"/> </searchParam> <searchParam> <name value="supplier"/> <type value="reference"/> <documentation value="Dispenser"/> <xpath value="f:Supply/f:dispense/f:supplier"/> </searchParam> </structure> </Profile> </content> <summary type="xhtml"><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="supply-definitions.html#Supply" title="A supply - a request for something, and provision of what is supplied."><b>Supply</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="supply-definitions.html#Supply.kind" title="Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process."><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 href="valueset-supply-type.html" style="color: navy">The kind of supply (central, non-stock, etc)</a></span><span style="color: Gray"> --></span></kind> <<a class="dict" href="supply-definitions.html#Supply.identifier" title="Unique identifier for this supply request."><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> <<a class="dict" href="supply-definitions.html#Supply.status" title="Status of the supply request."><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 href="valueset-supply-status.html" style="color: navy">requested | dispensed | received | failed | cancelled</a></span><span style="color: Gray"> --></span> <<a class="dict" href="supply-definitions.html#Supply.orderedItem" title="The item that is requested to be supplied."><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"> Medication, Substance, or Device requested to be supplied</span><span style="color: Gray"> --></span></orderedItem> <<a class="dict" href="supply-definitions.html#Supply.patient" title="A link to a resource representing the person whom the ordered item is for."><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> <<a class="dict" href="supply-definitions.html#Supply.dispense" title="Indicates the details of the dispense event such as the days supply and quantity of a supply dispensed."><b>dispense</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Supply details --></span> <<a class="dict" href="supply-definitions.html#Supply.dispense.identifier" title="Identifier assigned by the dispensing facility when the dispense occurs."><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> <<a class="dict" href="supply-definitions.html#Supply.dispense.status" title="A code specifying the state of the dispense event (this element modifies the meaning of other elements)"><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 href="valueset-supply-dispense-status.html" style="color: navy">in progress | dispensed | abandoned</a></span><span style="color: Gray"> --></span> <<a class="dict" href="supply-definitions.html#Supply.dispense.type" title="Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc."><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 href="valueset-supply-item.html" style="color: navy">Category of dispense event</a></span><span style="color: Gray"> --></span></type> <<a class="dict" href="supply-definitions.html#Supply.dispense.quantity" title="The amount of supply that has been dispensed. Includes unit of measure."><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> <<a class="dict" href="supply-definitions.html#Supply.dispense.suppliedItem" 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."><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"> Medication, Substance, or Device supplied</span><span style="color: Gray"> --></span></suppliedItem> <<a class="dict" href="supply-definitions.html#Supply.dispense.supplier" title="The individual responsible for dispensing the medication."><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> <<a class="dict" href="supply-definitions.html#Supply.dispense.whenPrepared" title="The time the dispense event occurred."><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> <<a class="dict" href="supply-definitions.html#Supply.dispense.whenHandedOver" title="The time the dispensed item was sent or handed to the patient (or agent)."><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> <<a class="dict" href="supply-definitions.html#Supply.dispense.destination" title="Identification of the facility/location where the Supply was shipped to, as part of the dispense event."><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> <<a class="dict" href="supply-definitions.html#Supply.dispense.receiver" title="Identifies the person who picked up the Supply."><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> </dispense> </Supply> </pre></div> </summary> </entry> </feed>
© 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