STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Compartmentdefinition-patient.xml

Raw XML (canonical form)

Compartment Definition for patient

<CompartmentDefinition xmlns="http://hl7.org/fhir">
  <id value="patient"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p>
The following resources may be in this compartment:
</p>

      <table class="grid">
 
        <tr>
          <td>
            <b>Resource</b>
          </td>
          <td>
            <b>Inclusion Criteria</b>
          </td>
        </tr>
 
        <tr>
          <td>
            <a href="account.html">Account</a>
          </td>
          <td>subject</td>
        </tr>
 
        <tr>
          <td>
            <a href="allergyintolerance.html">AllergyIntolerance</a>
          </td>
          <td>patient, recorder, reporter</td>
        </tr>
 
        <tr>
          <td>
            <a href="appointment.html">Appointment</a>
          </td>
          <td>actor</td>
        </tr>
 
        <tr>
          <td>
            <a href="appointmentresponse.html">AppointmentResponse</a>
          </td>
          <td>actor</td>
        </tr>
 
        <tr>
          <td>
            <a href="auditevent.html">AuditEvent</a>
          </td>
          <td>patient, agent.patient, entity.patient</td>
        </tr>
 
        <tr>
          <td>
            <a href="basic.html">Basic</a>
          </td>
          <td>patient, author</td>
        </tr>
 
        <tr>
          <td>
            <a href="bodysite.html">BodySite</a>
          </td>
          <td>patient</td>
        </tr>
 
        <tr>
          <td>
            <a href="careplan.html">CarePlan</a>
          </td>
          <td>patient, participant, performer</td>
        </tr>
 
        <tr>
          <td>
            <a href="careteam.html">CareTeam</a>
          </td>
          <td>patient, participant</td>
        </tr>
 
        <tr>
          <td>
            <a href="claim.html">Claim</a>
          </td>
          <td>patientidentifier, patientreference</td>
        </tr>
 
        <tr>
          <td>
            <a href="clinicalimpression.html">ClinicalImpression</a>
          </td>
          <td>patient</td>
        </tr>
 
        <tr>
          <td>
            <a href="communication.html">Communication</a>
          </td>
          <td>subject, sender, recipient</td>
        </tr>
 
        <tr>
          <td>
            <a href="communicationrequest.html">CommunicationRequest</a>
          </td>
          <td>subject, sender, recipient, requester</td>
        </tr>
 
        <tr>
          <td>
            <a href="composition.html">Composition</a>
          </td>
          <td>subject, author, attester</td>
        </tr>
 
        <tr>
          <td>
            <a href="condition.html">Condition</a>
          </td>
          <td>patient</td>
        </tr>
 
        <tr>
          <td>
            <a href="detectedissue.html">DetectedIssue</a>
          </td>
          <td>patient</td>
        </tr>
 
        <tr>
          <td>
            <a href="deviceuserequest.html">DeviceUseRequest</a>
          </td>
          <td>subject</td>
        </tr>
 
        <tr>
          <td>
            <a href="deviceusestatement.html">DeviceUseStatement</a>
          </td>
          <td>subject</td>
        </tr>
 
        <tr>
          <td>
            <a href="diagnosticorder.html">DiagnosticOrder</a>
          </td>
          <td>subject</td>
        </tr>
 
        <tr>
          <td>
            <a href="diagnosticreport.html">DiagnosticReport</a>
          </td>
          <td>subject</td>
        </tr>
 
        <tr>
          <td>
            <a href="documentmanifest.html">DocumentManifest</a>
          </td>
          <td>subject, author, recipient</td>
        </tr>
 
        <tr>
          <td>
            <a href="documentreference.html">DocumentReference</a>
          </td>
          <td>subject, author</td>
        </tr>
 
        <tr>
          <td>
            <a href="encounter.html">Encounter</a>
          </td>
          <td>patient</td>
        </tr>
 
        <tr>
          <td>
            <a href="enrollmentrequest.html">EnrollmentRequest</a>
          </td>
          <td>subject</td>
        </tr>
 
        <tr>
          <td>
            <a href="episodeofcare.html">EpisodeOfCare</a>
          </td>
          <td>patient</td>
        </tr>
 
        <tr>
          <td>
            <a href="familymemberhistory.html">FamilyMemberHistory</a>
          </td>
          <td>patient</td>
        </tr>
 
        <tr>
          <td>
            <a href="flag.html">Flag</a>
          </td>
          <td>patient</td>
        </tr>
 
        <tr>
          <td>
            <a href="goal.html">Goal</a>
          </td>
          <td>patient</td>
        </tr>
 
        <tr>
          <td>
            <a href="group.html">Group</a>
          </td>
          <td>member</td>
        </tr>
 
        <tr>
          <td>
            <a href="imagingexcerpt.html">ImagingExcerpt</a>
          </td>
          <td>patient</td>
        </tr>
 
        <tr>
          <td>
            <a href="imagingobjectselection.html">ImagingObjectSelection</a>
          </td>
          <td>patient, author</td>
        </tr>
 
        <tr>
          <td>
            <a href="imagingstudy.html">ImagingStudy</a>
          </td>
          <td>patient</td>
        </tr>
 
        <tr>
          <td>
            <a href="immunization.html">Immunization</a>
          </td>
          <td>patient</td>
        </tr>
 
        <tr>
          <td>
            <a href="immunizationrecommendation.html">ImmunizationRecommendation</a>
          </td>
          <td>patient</td>
        </tr>
 
        <tr>
          <td>
            <a href="list.html">List</a>
          </td>
          <td>subject, source</td>
        </tr>
 
        <tr>
          <td>
            <a href="measurereport.html">MeasureReport</a>
          </td>
          <td>patient</td>
        </tr>
 
        <tr>
          <td>
            <a href="media.html">Media</a>
          </td>
          <td>subject</td>
        </tr>
 
        <tr>
          <td>
            <a href="medicationadministration.html">MedicationAdministration</a>
          </td>
          <td>patient</td>
        </tr>
 
        <tr>
          <td>
            <a href="medicationdispense.html">MedicationDispense</a>
          </td>
          <td>patient</td>
        </tr>
 
        <tr>
          <td>
            <a href="medicationorder.html">MedicationOrder</a>
          </td>
          <td>patient</td>
        </tr>
 
        <tr>
          <td>
            <a href="medicationstatement.html">MedicationStatement</a>
          </td>
          <td>patient, source</td>
        </tr>
 
        <tr>
          <td>
            <a href="nutritionorder.html">NutritionOrder</a>
          </td>
          <td>patient</td>
        </tr>
 
        <tr>
          <td>
            <a href="observation.html">Observation</a>
          </td>
          <td>subject, performer</td>
        </tr>
 
        <tr>
          <td>
            <a href="order.html">Order</a>
          </td>
          <td>subject</td>
        </tr>
 
        <tr>
          <td>
            <a href="orderresponse.html">OrderResponse</a>
          </td>
          <td>request.patient</td>
        </tr>
 
        <tr>
          <td>
            <a href="patient.html">Patient</a>
          </td>
          <td>link</td>
        </tr>
 
        <tr>
          <td>
            <a href="person.html">Person</a>
          </td>
          <td>patient</td>
        </tr>
 
        <tr>
          <td>
            <a href="procedure.html">Procedure</a>
          </td>
          <td>patient, performer</td>
        </tr>
 
        <tr>
          <td>
            <a href="procedurerequest.html">ProcedureRequest</a>
          </td>
          <td>subject, orderer, performer</td>
        </tr>
 
        <tr>
          <td>
            <a href="provenance.html">Provenance</a>
          </td>
          <td>target.subject, target.patient, patient</td>
        </tr>
 
        <tr>
          <td>
            <a href="questionnaireresponse.html">QuestionnaireResponse</a>
          </td>
          <td>subject, author</td>
        </tr>
 
        <tr>
          <td>
            <a href="referralrequest.html">ReferralRequest</a>
          </td>
          <td>patient, requester</td>
        </tr>
 
        <tr>
          <td>
            <a href="relatedperson.html">RelatedPerson</a>
          </td>
          <td>patient</td>
        </tr>
 
        <tr>
          <td>
            <a href="riskassessment.html">RiskAssessment</a>
          </td>
          <td>subject</td>
        </tr>
 
        <tr>
          <td>
            <a href="schedule.html">Schedule</a>
          </td>
          <td>actor</td>
        </tr>
 
        <tr>
          <td>
            <a href="specimen.html">Specimen</a>
          </td>
          <td>subject</td>
        </tr>
 
        <tr>
          <td>
            <a href="supplydelivery.html">SupplyDelivery</a>
          </td>
          <td>patient</td>
        </tr>
 
        <tr>
          <td>
            <a href="supplyrequest.html">SupplyRequest</a>
          </td>
          <td>patient</td>
        </tr>
 
        <tr>
          <td>
            <a href="visionprescription.html">VisionPrescription</a>
          </td>
          <td>patient</td>
        </tr>

      </table>

      <p>
A resource is in this compartment if the nominated search parameter (or chain) refers
         to the patient resource that defines the compartment.
</p>

      <p>

</p>

      <p>
The following resources are never in this compartment:
</p>

      <ul>
 
        <li>
          <a href="binary.html">Binary</a>
        </li>
 
        <li>
          <a href="bundle.html">Bundle</a>
        </li>
 
        <li>
          <a href="claimresponse.html">ClaimResponse</a>
        </li>
 
        <li>
          <a href="codesystem.html">CodeSystem</a>
        </li>
 
        <li>
          <a href="compartmentdefinition.html">CompartmentDefinition</a>
        </li>
 
        <li>
          <a href="conceptmap.html">ConceptMap</a>
        </li>
 
        <li>
          <a href="conformance.html">Conformance</a>
        </li>
 
        <li>
          <a href="contract.html">Contract</a>
        </li>
 
        <li>
          <a href="coverage.html">Coverage</a>
        </li>
 
        <li>
          <a href="dataelement.html">DataElement</a>
        </li>
 
        <li>
          <a href="decisionsupportrule.html">DecisionSupportRule</a>
        </li>
 
        <li>
          <a href="decisionsupportservicemodule.html">DecisionSupportServiceModule</a>
        </li>
 
        <li>
          <a href="device.html">Device</a>
        </li>
 
        <li>
          <a href="devicecomponent.html">DeviceComponent</a>
        </li>
 
        <li>
          <a href="devicemetric.html">DeviceMetric</a>
        </li>
 
        <li>
          <a href="eligibilityrequest.html">EligibilityRequest</a>
        </li>
 
        <li>
          <a href="eligibilityresponse.html">EligibilityResponse</a>
        </li>
 
        <li>
          <a href="enrollmentresponse.html">EnrollmentResponse</a>
        </li>
 
        <li>
          <a href="expansionprofile.html">ExpansionProfile</a>
        </li>
 
        <li>
          <a href="explanationofbenefit.html">ExplanationOfBenefit</a>
        </li>
 
        <li>
          <a href="guidanceresponse.html">GuidanceResponse</a>
        </li>
 
        <li>
          <a href="healthcareservice.html">HealthcareService</a>
        </li>
 
        <li>
          <a href="implementationguide.html">ImplementationGuide</a>
        </li>
 
        <li>
          <a href="library.html">Library</a>
        </li>
 
        <li>
          <a href="linkage.html">Linkage</a>
        </li>
 
        <li>
          <a href="location.html">Location</a>
        </li>
 
        <li>
          <a href="measure.html">Measure</a>
        </li>
 
        <li>
          <a href="medication.html">Medication</a>
        </li>
 
        <li>
          <a href="messageheader.html">MessageHeader</a>
        </li>
 
        <li>
          <a href="moduledefinition.html">ModuleDefinition</a>
        </li>
 
        <li>
          <a href="namingsystem.html">NamingSystem</a>
        </li>
 
        <li>
          <a href="operationdefinition.html">OperationDefinition</a>
        </li>
 
        <li>
          <a href="operationoutcome.html">OperationOutcome</a>
        </li>
 
        <li>
          <a href="orderset.html">OrderSet</a>
        </li>
 
        <li>
          <a href="organization.html">Organization</a>
        </li>
 
        <li>
          <a href="paymentnotice.html">PaymentNotice</a>
        </li>
 
        <li>
          <a href="paymentreconciliation.html">PaymentReconciliation</a>
        </li>
 
        <li>
          <a href="practitioner.html">Practitioner</a>
        </li>
 
        <li>
          <a href="practitionerrole.html">PractitionerRole</a>
        </li>
 
        <li>
          <a href="processrequest.html">ProcessRequest</a>
        </li>
 
        <li>
          <a href="processresponse.html">ProcessResponse</a>
        </li>
 
        <li>
          <a href="protocol.html">Protocol</a>
        </li>
 
        <li>
          <a href="questionnaire.html">Questionnaire</a>
        </li>
 
        <li>
          <a href="searchparameter.html">SearchParameter</a>
        </li>
 
        <li>
          <a href="sequence.html">Sequence</a>
        </li>
 
        <li>
          <a href="slot.html">Slot</a>
        </li>
 
        <li>
          <a href="structuredefinition.html">StructureDefinition</a>
        </li>
 
        <li>
          <a href="structuremap.html">StructureMap</a>
        </li>
 
        <li>
          <a href="subscription.html">Subscription</a>
        </li>
 
        <li>
          <a href="substance.html">Substance</a>
        </li>
 
        <li>
          <a href="task.html">Task</a>
        </li>
 
        <li>
          <a href="testscript.html">TestScript</a>
        </li>
 
        <li>
          <a href="valueset.html">ValueSet</a>
        </li>

      </ul>
    </div>
  </text>
  <url value="http://hl7.org/fhir/CompartmentDefinition/patient"/>
  <name value="Base FHIR compartment definition for Patient"/>
  <status value="draft"/>
  <experimental value="true"/>
  <publisher value="FHIR Project Team"/>
  <contact>
    <telecom>
      <system value="other"/>
      <value value="http://hl7.org/fhir"/>
    </telecom>
  </contact>
  <date value="2016-03-31T08:01:25+11:00"/>
  <description value="There is an instance of the patient compartment for each patient resource, and the identity
   of the compartment is the same as the patient. When a patient is linked to another patient,
   all the records associated with the linked patient are in the compartment associated with
   the target of the link.. The set of resources associated with a particular patient"/>
  <code value="Patient"/>
  <search value="true"/>
  <resource>
    <code value="Account"/>
    <param value="subject"/>
  </resource>
  <resource>
    <code value="AllergyIntolerance"/>
    <param value="patient"/>
    <param value="recorder"/>
    <param value="reporter"/>
  </resource>
  <resource>
    <code value="Appointment"/>
    <param value="actor"/>
  </resource>
  <resource>
    <code value="AppointmentResponse"/>
    <param value="actor"/>
  </resource>
  <resource>
    <code value="AuditEvent"/>
    <param value="patient"/>
    <param value="agent.patient"/>
    <param value="entity.patient"/>
  </resource>
  <resource>
    <code value="Basic"/>
    <param value="patient"/>
    <param value="author"/>
  </resource>
  <resource>
    <code value="Binary"/>
  </resource>
  <resource>
    <code value="BodySite"/>
    <param value="patient"/>
  </resource>
  <resource>
    <code value="Bundle"/>
  </resource>
  <resource>
    <code value="CarePlan"/>
    <param value="patient"/>
    <param value="participant"/>
    <param value="performer"/>
  </resource>
  <resource>
    <code value="CareTeam"/>
    <param value="patient"/>
    <param value="participant"/>
  </resource>
  <resource>
    <code value="Claim"/>
    <param value="patientidentifier"/>
    <param value="patientreference"/>
  </resource>
  <resource>
    <code value="ClaimResponse"/>
  </resource>
  <resource>
    <code value="ClinicalImpression"/>
    <param value="patient"/>
  </resource>
  <resource>
    <code value="CodeSystem"/>
  </resource>
  <resource>
    <code value="Communication"/>
    <param value="subject"/>
    <param value="sender"/>
    <param value="recipient"/>
  </resource>
  <resource>
    <code value="CommunicationRequest"/>
    <param value="subject"/>
    <param value="sender"/>
    <param value="recipient"/>
    <param value="requester"/>
  </resource>
  <resource>
    <code value="CompartmentDefinition"/>
  </resource>
  <resource>
    <code value="Composition"/>
    <param value="subject"/>
    <param value="author"/>
    <param value="attester"/>
  </resource>
  <resource>
    <code value="ConceptMap"/>
  </resource>
  <resource>
    <code value="Condition"/>
    <param value="patient"/>
  </resource>
  <resource>
    <code value="Conformance"/>
  </resource>
  <resource>
    <code value="Contract"/>
  </resource>
  <resource>
    <code value="Coverage"/>
  </resource>
  <resource>
    <code value="DataElement"/>
  </resource>
  <resource>
    <code value="DecisionSupportRule"/>
  </resource>
  <resource>
    <code value="DecisionSupportServiceModule"/>
  </resource>
  <resource>
    <code value="DetectedIssue"/>
    <param value="patient"/>
  </resource>
  <resource>
    <code value="Device"/>
  </resource>
  <resource>
    <code value="DeviceComponent"/>
  </resource>
  <resource>
    <code value="DeviceMetric"/>
  </resource>
  <resource>
    <code value="DeviceUseRequest"/>
    <param value="subject"/>
  </resource>
  <resource>
    <code value="DeviceUseStatement"/>
    <param value="subject"/>
  </resource>
  <resource>
    <code value="DiagnosticOrder"/>
    <param value="subject"/>
  </resource>
  <resource>
    <code value="DiagnosticReport"/>
    <param value="subject"/>
  </resource>
  <resource>
    <code value="DocumentManifest"/>
    <param value="subject"/>
    <param value="author"/>
    <param value="recipient"/>
  </resource>
  <resource>
    <code value="DocumentReference"/>
    <param value="subject"/>
    <param value="author"/>
  </resource>
  <resource>
    <code value="EligibilityRequest"/>
  </resource>
  <resource>
    <code value="EligibilityResponse"/>
  </resource>
  <resource>
    <code value="Encounter"/>
    <param value="patient"/>
  </resource>
  <resource>
    <code value="EnrollmentRequest"/>
    <param value="subject"/>
  </resource>
  <resource>
    <code value="EnrollmentResponse"/>
  </resource>
  <resource>
    <code value="EpisodeOfCare"/>
    <param value="patient"/>
  </resource>
  <resource>
    <code value="ExpansionProfile"/>
  </resource>
  <resource>
    <code value="ExplanationOfBenefit"/>
  </resource>
  <resource>
    <code value="FamilyMemberHistory"/>
    <param value="patient"/>
  </resource>
  <resource>
    <code value="Flag"/>
    <param value="patient"/>
  </resource>
  <resource>
    <code value="Goal"/>
    <param value="patient"/>
  </resource>
  <resource>
    <code value="Group"/>
    <param value="member"/>
  </resource>
  <resource>
    <code value="GuidanceResponse"/>
  </resource>
  <resource>
    <code value="HealthcareService"/>
  </resource>
  <resource>
    <code value="ImagingExcerpt"/>
    <param value="patient"/>
  </resource>
  <resource>
    <code value="ImagingObjectSelection"/>
    <param value="patient"/>
    <param value="author"/>
  </resource>
  <resource>
    <code value="ImagingStudy"/>
    <param value="patient"/>
  </resource>
  <resource>
    <code value="Immunization"/>
    <param value="patient"/>
  </resource>
  <resource>
    <code value="ImmunizationRecommendation"/>
    <param value="patient"/>
  </resource>
  <resource>
    <code value="ImplementationGuide"/>
  </resource>
  <resource>
    <code value="Library"/>
  </resource>
  <resource>
    <code value="Linkage"/>
  </resource>
  <resource>
    <code value="List"/>
    <param value="subject"/>
    <param value="source"/>
  </resource>
  <resource>
    <code value="Location"/>
  </resource>
  <resource>
    <code value="Measure"/>
  </resource>
  <resource>
    <code value="MeasureReport"/>
    <param value="patient"/>
  </resource>
  <resource>
    <code value="Media"/>
    <param value="subject"/>
  </resource>
  <resource>
    <code value="Medication"/>
  </resource>
  <resource>
    <code value="MedicationAdministration"/>
    <param value="patient"/>
  </resource>
  <resource>
    <code value="MedicationDispense"/>
    <param value="patient"/>
  </resource>
  <resource>
    <code value="MedicationOrder"/>
    <param value="patient"/>
  </resource>
  <resource>
    <code value="MedicationStatement"/>
    <param value="patient"/>
    <param value="source"/>
  </resource>
  <resource>
    <code value="MessageHeader"/>
  </resource>
  <resource>
    <code value="ModuleDefinition"/>
  </resource>
  <resource>
    <code value="NamingSystem"/>
  </resource>
  <resource>
    <code value="NutritionOrder"/>
    <param value="patient"/>
  </resource>
  <resource>
    <code value="Observation"/>
    <param value="subject"/>
    <param value="performer"/>
  </resource>
  <resource>
    <code value="OperationDefinition"/>
  </resource>
  <resource>
    <code value="OperationOutcome"/>
  </resource>
  <resource>
    <code value="Order"/>
    <param value="subject"/>
  </resource>
  <resource>
    <code value="OrderResponse"/>
    <param value="request.patient"/>
  </resource>
  <resource>
    <code value="OrderSet"/>
  </resource>
  <resource>
    <code value="Organization"/>
  </resource>
  <resource>
    <code value="Patient"/>
    <param value="link"/>
  </resource>
  <resource>
    <code value="PaymentNotice"/>
  </resource>
  <resource>
    <code value="PaymentReconciliation"/>
  </resource>
  <resource>
    <code value="Person"/>
    <param value="patient"/>
  </resource>
  <resource>
    <code value="Practitioner"/>
  </resource>
  <resource>
    <code value="PractitionerRole"/>
  </resource>
  <resource>
    <code value="Procedure"/>
    <param value="patient"/>
    <param value="performer"/>
  </resource>
  <resource>
    <code value="ProcedureRequest"/>
    <param value="subject"/>
    <param value="orderer"/>
    <param value="performer"/>
  </resource>
  <resource>
    <code value="ProcessRequest"/>
  </resource>
  <resource>
    <code value="ProcessResponse"/>
  </resource>
  <resource>
    <code value="Protocol"/>
  </resource>
  <resource>
    <code value="Provenance"/>
    <param value="target.subject"/>
    <param value="target.patient"/>
    <param value="patient"/>
  </resource>
  <resource>
    <code value="Questionnaire"/>
  </resource>
  <resource>
    <code value="QuestionnaireResponse"/>
    <param value="subject"/>
    <param value="author"/>
  </resource>
  <resource>
    <code value="ReferralRequest"/>
    <param value="patient"/>
    <param value="requester"/>
  </resource>
  <resource>
    <code value="RelatedPerson"/>
    <param value="patient"/>
  </resource>
  <resource>
    <code value="RiskAssessment"/>
    <param value="subject"/>
  </resource>
  <resource>
    <code value="Schedule"/>
    <param value="actor"/>
  </resource>
  <resource>
    <code value="SearchParameter"/>
  </resource>
  <resource>
    <code value="Sequence"/>
  </resource>
  <resource>
    <code value="Slot"/>
  </resource>
  <resource>
    <code value="Specimen"/>
    <param value="subject"/>
  </resource>
  <resource>
    <code value="StructureDefinition"/>
  </resource>
  <resource>
    <code value="StructureMap"/>
  </resource>
  <resource>
    <code value="Subscription"/>
  </resource>
  <resource>
    <code value="Substance"/>
  </resource>
  <resource>
    <code value="SupplyDelivery"/>
    <param value="patient"/>
  </resource>
  <resource>
    <code value="SupplyRequest"/>
    <param value="patient"/>
  </resource>
  <resource>
    <code value="Task"/>
  </resource>
  <resource>
    <code value="TestScript"/>
  </resource>
  <resource>
    <code value="ValueSet"/>
  </resource>
  <resource>
    <code value="VisionPrescription"/>
    <param value="patient"/>
  </resource>
</CompartmentDefinition>

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.