FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 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-relatedperson.xml

FHIR Infrastructure Work GroupMaturity Level: N/ABallot Status: Informative

Raw XML (canonical form)

Jump past Narrative

Compartment Definition for relatedPerson

<CompartmentDefinition xmlns="http://hl7.org/fhir">
  <id value="relatedPerson"/> 
  <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="adverseevent.html">AdverseEvent</a> 
          </td> 
          <td> recorder</td> 
        </tr> 
 
        <tr> 
          <td> 
            <a href="allergyintolerance.html">AllergyIntolerance</a> 
          </td> 
          <td> asserter</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="basic.html">Basic</a> 
          </td> 
          <td> author</td> 
        </tr> 
 
        <tr> 
          <td> 
            <a href="careplan.html">CarePlan</a> 
          </td> 
          <td> performer</td> 
        </tr> 
 
        <tr> 
          <td> 
            <a href="careteam.html">CareTeam</a> 
          </td> 
          <td> participant</td> 
        </tr> 
 
        <tr> 
          <td> 
            <a href="chargeitem.html">ChargeItem</a> 
          </td> 
          <td> enterer, participant-actor</td> 
        </tr> 
 
        <tr> 
          <td> 
            <a href="claim.html">Claim</a> 
          </td> 
          <td> payee</td> 
        </tr> 
 
        <tr> 
          <td> 
            <a href="communication.html">Communication</a> 
          </td> 
          <td> sender, recipient</td> 
        </tr> 
 
        <tr> 
          <td> 
            <a href="communicationrequest.html">CommunicationRequest</a> 
          </td> 
          <td> sender, recipient, requester</td> 
        </tr> 
 
        <tr> 
          <td> 
            <a href="composition.html">Composition</a> 
          </td> 
          <td> author</td> 
        </tr> 
 
        <tr> 
          <td> 
            <a href="condition.html">Condition</a> 
          </td> 
          <td> asserter</td> 
        </tr> 
 
        <tr> 
          <td> 
            <a href="coverage.html">Coverage</a> 
          </td> 
          <td> policy-holder, subscriber, payor</td> 
        </tr> 
 
        <tr> 
          <td> 
            <a href="documentmanifest.html">DocumentManifest</a> 
          </td> 
          <td> author</td> 
        </tr> 
 
        <tr> 
          <td> 
            <a href="documentreference.html">DocumentReference</a> 
          </td> 
          <td> author</td> 
        </tr> 
 
        <tr> 
          <td> 
            <a href="encounter.html">Encounter</a> 
          </td> 
          <td> participant</td> 
        </tr> 
 
        <tr> 
          <td> 
            <a href="explanationofbenefit.html">ExplanationOfBenefit</a> 
          </td> 
          <td> payee</td> 
        </tr> 
 
        <tr> 
          <td> 
            <a href="imagingmanifest.html">ImagingManifest</a> 
          </td> 
          <td> author</td> 
        </tr> 
 
        <tr> 
          <td> 
            <a href="medicationadministration.html">MedicationAdministration</a> 
          </td> 
          <td> performer</td> 
        </tr> 
 
        <tr> 
          <td> 
            <a href="medicationstatement.html">MedicationStatement</a> 
          </td> 
          <td> source</td> 
        </tr> 
 
        <tr> 
          <td> 
            <a href="observation.html">Observation</a> 
          </td> 
          <td> performer</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> link</td> 
        </tr> 
 
        <tr> 
          <td> 
            <a href="procedure.html">Procedure</a> 
          </td> 
          <td> performer</td> 
        </tr> 
 
        <tr> 
          <td> 
            <a href="procedurerequest.html">ProcedureRequest</a> 
          </td> 
          <td> performer</td> 
        </tr> 
 
        <tr> 
          <td> 
            <a href="provenance.html">Provenance</a> 
          </td> 
          <td> agent</td> 
        </tr> 
 
        <tr> 
          <td> 
            <a href="questionnaireresponse.html">QuestionnaireResponse</a> 
          </td> 
          <td> author, source</td> 
        </tr> 
 
        <tr> 
          <td> 
            <a href="relatedperson.html">RelatedPerson</a> 
          </td> 
          <td> {def}</td> 
        </tr> 
 
        <tr> 
          <td> 
            <a href="requestgroup.html">RequestGroup</a> 
          </td> 
          <td> participant</td> 
        </tr> 
 
        <tr> 
          <td> 
            <a href="schedule.html">Schedule</a> 
          </td> 
          <td> actor</td> 
        </tr> 
 
        <tr> 
          <td> 
            <a href="supplyrequest.html">SupplyRequest</a> 
          </td> 
          <td> requester</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="account.html">Account</a> 
        </li> 
 
        <li> 
          <a href="activitydefinition.html">ActivityDefinition</a> 
        </li> 
 
        <li> 
          <a href="auditevent.html">AuditEvent</a> 
        </li> 
 
        <li> 
          <a href="binary.html">Binary</a> 
        </li> 
 
        <li> 
          <a href="bodysite.html">BodySite</a> 
        </li> 
 
        <li> 
          <a href="bundle.html">Bundle</a> 
        </li> 
 
        <li> 
          <a href="capabilitystatement.html">CapabilityStatement</a> 
        </li> 
 
        <li> 
          <a href="claimresponse.html">ClaimResponse</a> 
        </li> 
 
        <li> 
          <a href="clinicalimpression.html">ClinicalImpression</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="consent.html">Consent</a> 
        </li> 
 
        <li> 
          <a href="contract.html">Contract</a> 
        </li> 
 
        <li> 
          <a href="dataelement.html">DataElement</a> 
        </li> 
 
        <li> 
          <a href="detectedissue.html">DetectedIssue</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="devicerequest.html">DeviceRequest</a> 
        </li> 
 
        <li> 
          <a href="deviceusestatement.html">DeviceUseStatement</a> 
        </li> 
 
        <li> 
          <a href="diagnosticreport.html">DiagnosticReport</a> 
        </li> 
 
        <li> 
          <a href="eligibilityrequest.html">EligibilityRequest</a> 
        </li> 
 
        <li> 
          <a href="eligibilityresponse.html">EligibilityResponse</a> 
        </li> 
 
        <li> 
          <a href="endpoint.html">Endpoint</a> 
        </li> 
 
        <li> 
          <a href="enrollmentrequest.html">EnrollmentRequest</a> 
        </li> 
 
        <li> 
          <a href="enrollmentresponse.html">EnrollmentResponse</a> 
        </li> 
 
        <li> 
          <a href="episodeofcare.html">EpisodeOfCare</a> 
        </li> 
 
        <li> 
          <a href="expansionprofile.html">ExpansionProfile</a> 
        </li> 
 
        <li> 
          <a href="familymemberhistory.html">FamilyMemberHistory</a> 
        </li> 
 
        <li> 
          <a href="flag.html">Flag</a> 
        </li> 
 
        <li> 
          <a href="goal.html">Goal</a> 
        </li> 
 
        <li> 
          <a href="graphdefinition.html">GraphDefinition</a> 
        </li> 
 
        <li> 
          <a href="group.html">Group</a> 
        </li> 
 
        <li> 
          <a href="guidanceresponse.html">GuidanceResponse</a> 
        </li> 
 
        <li> 
          <a href="healthcareservice.html">HealthcareService</a> 
        </li> 
 
        <li> 
          <a href="imagingstudy.html">ImagingStudy</a> 
        </li> 
 
        <li> 
          <a href="immunization.html">Immunization</a> 
        </li> 
 
        <li> 
          <a href="immunizationrecommendation.html">ImmunizationRecommendation</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="list.html">List</a> 
        </li> 
 
        <li> 
          <a href="location.html">Location</a> 
        </li> 
 
        <li> 
          <a href="measure.html">Measure</a> 
        </li> 
 
        <li> 
          <a href="measurereport.html">MeasureReport</a> 
        </li> 
 
        <li> 
          <a href="media.html">Media</a> 
        </li> 
 
        <li> 
          <a href="medication.html">Medication</a> 
        </li> 
 
        <li> 
          <a href="medicationdispense.html">MedicationDispense</a> 
        </li> 
 
        <li> 
          <a href="medicationrequest.html">MedicationRequest</a> 
        </li> 
 
        <li> 
          <a href="messagedefinition.html">MessageDefinition</a> 
        </li> 
 
        <li> 
          <a href="messageheader.html">MessageHeader</a> 
        </li> 
 
        <li> 
          <a href="namingsystem.html">NamingSystem</a> 
        </li> 
 
        <li> 
          <a href="nutritionorder.html">NutritionOrder</a> 
        </li> 
 
        <li> 
          <a href="operationdefinition.html">OperationDefinition</a> 
        </li> 
 
        <li> 
          <a href="operationoutcome.html">OperationOutcome</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="plandefinition.html">PlanDefinition</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="questionnaire.html">Questionnaire</a> 
        </li> 
 
        <li> 
          <a href="referralrequest.html">ReferralRequest</a> 
        </li> 
 
        <li> 
          <a href="researchstudy.html">ResearchStudy</a> 
        </li> 
 
        <li> 
          <a href="researchsubject.html">ResearchSubject</a> 
        </li> 
 
        <li> 
          <a href="riskassessment.html">RiskAssessment</a> 
        </li> 
 
        <li> 
          <a href="searchparameter.html">SearchParameter</a> 
        </li> 
 
        <li> 
          <a href="sequence.html">Sequence</a> 
        </li> 
 
        <li> 
          <a href="servicedefinition.html">ServiceDefinition</a> 
        </li> 
 
        <li> 
          <a href="slot.html">Slot</a> 
        </li> 
 
        <li> 
          <a href="specimen.html">Specimen</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="supplydelivery.html">SupplyDelivery</a> 
        </li> 
 
        <li> 
          <a href="task.html">Task</a> 
        </li> 
 
        <li> 
          <a href="testreport.html">TestReport</a> 
        </li> 
 
        <li> 
          <a href="testscript.html">TestScript</a> 
        </li> 
 
        <li> 
          <a href="valueset.html">ValueSet</a> 
        </li> 
 
        <li> 
          <a href="visionprescription.html">VisionPrescription</a> 
        </li> 

      </ul> 
    </div> 
  </text> 
  <url value="http://hl7.org/fhir/CompartmentDefinition/relatedPerson"/> 
  <name value="Base FHIR compartment definition for RelatedPerson"/> 
  <status value="draft"/> 
  <experimental value="true"/> 
  <date value="2019-10-24T11:53:00+11:00"/> 
  <publisher value="FHIR Project Team"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
  </contact> 
  <description value="There is an instance of the relatedPerson compartment for each relatedPerson resource,
   and the identity of the compartment is the same as the relatedPerson. The set of resources
   associated with a particular 'related person'"/> 
  <code value="RelatedPerson"/> 
  <search value="true"/> 
  <resource> 
    <code value="Account"/> 
  </resource> 
  <resource> 
    <code value="ActivityDefinition"/> 
  </resource> 
  <resource> 
    <code value="AdverseEvent"/> 
    <param value="recorder"/> 
  </resource> 
  <resource> 
    <code value="AllergyIntolerance"/> 
    <param value="asserter"/> 
  </resource> 
  <resource> 
    <code value="Appointment"/> 
    <param value="actor"/> 
  </resource> 
  <resource> 
    <code value="AppointmentResponse"/> 
    <param value="actor"/> 
  </resource> 
  <resource> 
    <code value="AuditEvent"/> 
  </resource> 
  <resource> 
    <code value="Basic"/> 
    <param value="author"/> 
  </resource> 
  <resource> 
    <code value="Binary"/> 
  </resource> 
  <resource> 
    <code value="BodySite"/> 
  </resource> 
  <resource> 
    <code value="Bundle"/> 
  </resource> 
  <resource> 
    <code value="CapabilityStatement"/> 
  </resource> 
  <resource> 
    <code value="CarePlan"/> 
    <param value="performer"/> 
  </resource> 
  <resource> 
    <code value="CareTeam"/> 
    <param value="participant"/> 
  </resource> 
  <resource> 
    <code value="ChargeItem"/> 
    <param value="enterer"/> 
    <param value="participant-actor"/> 
  </resource> 
  <resource> 
    <code value="Claim"/> 
    <param value="payee"/> 
  </resource> 
  <resource> 
    <code value="ClaimResponse"/> 
  </resource> 
  <resource> 
    <code value="ClinicalImpression"/> 
  </resource> 
  <resource> 
    <code value="CodeSystem"/> 
  </resource> 
  <resource> 
    <code value="Communication"/> 
    <param value="sender"/> 
    <param value="recipient"/> 
  </resource> 
  <resource> 
    <code value="CommunicationRequest"/> 
    <param value="sender"/> 
    <param value="recipient"/> 
    <param value="requester"/> 
  </resource> 
  <resource> 
    <code value="CompartmentDefinition"/> 
  </resource> 
  <resource> 
    <code value="Composition"/> 
    <param value="author"/> 
  </resource> 
  <resource> 
    <code value="ConceptMap"/> 
  </resource> 
  <resource> 
    <code value="Condition"/> 
    <param value="asserter"/> 
  </resource> 
  <resource> 
    <code value="Consent"/> 
  </resource> 
  <resource> 
    <code value="Contract"/> 
  </resource> 
  <resource> 
    <code value="Coverage"/> 
    <param value="policy-holder"/> 
    <param value="subscriber"/> 
    <param value="payor"/> 
  </resource> 
  <resource> 
    <code value="DataElement"/> 
  </resource> 
  <resource> 
    <code value="DetectedIssue"/> 
  </resource> 
  <resource> 
    <code value="Device"/> 
  </resource> 
  <resource> 
    <code value="DeviceComponent"/> 
  </resource> 
  <resource> 
    <code value="DeviceMetric"/> 
  </resource> 
  <resource> 
    <code value="DeviceRequest"/> 
  </resource> 
  <resource> 
    <code value="DeviceUseStatement"/> 
  </resource> 
  <resource> 
    <code value="DiagnosticReport"/> 
  </resource> 
  <resource> 
    <code value="DocumentManifest"/> 
    <param value="author"/> 
  </resource> 
  <resource> 
    <code value="DocumentReference"/> 
    <param value="author"/> 
  </resource> 
  <resource> 
    <code value="EligibilityRequest"/> 
  </resource> 
  <resource> 
    <code value="EligibilityResponse"/> 
  </resource> 
  <resource> 
    <code value="Encounter"/> 
    <param value="participant"/> 
  </resource> 
  <resource> 
    <code value="Endpoint"/> 
  </resource> 
  <resource> 
    <code value="EnrollmentRequest"/> 
  </resource> 
  <resource> 
    <code value="EnrollmentResponse"/> 
  </resource> 
  <resource> 
    <code value="EpisodeOfCare"/> 
  </resource> 
  <resource> 
    <code value="ExpansionProfile"/> 
  </resource> 
  <resource> 
    <code value="ExplanationOfBenefit"/> 
    <param value="payee"/> 
  </resource> 
  <resource> 
    <code value="FamilyMemberHistory"/> 
  </resource> 
  <resource> 
    <code value="Flag"/> 
  </resource> 
  <resource> 
    <code value="Goal"/> 
  </resource> 
  <resource> 
    <code value="GraphDefinition"/> 
  </resource> 
  <resource> 
    <code value="Group"/> 
  </resource> 
  <resource> 
    <code value="GuidanceResponse"/> 
  </resource> 
  <resource> 
    <code value="HealthcareService"/> 
  </resource> 
  <resource> 
    <code value="ImagingManifest"/> 
    <param value="author"/> 
  </resource> 
  <resource> 
    <code value="ImagingStudy"/> 
  </resource> 
  <resource> 
    <code value="Immunization"/> 
  </resource> 
  <resource> 
    <code value="ImmunizationRecommendation"/> 
  </resource> 
  <resource> 
    <code value="ImplementationGuide"/> 
  </resource> 
  <resource> 
    <code value="Library"/> 
  </resource> 
  <resource> 
    <code value="Linkage"/> 
  </resource> 
  <resource> 
    <code value="List"/> 
  </resource> 
  <resource> 
    <code value="Location"/> 
  </resource> 
  <resource> 
    <code value="Measure"/> 
  </resource> 
  <resource> 
    <code value="MeasureReport"/> 
  </resource> 
  <resource> 
    <code value="Media"/> 
  </resource> 
  <resource> 
    <code value="Medication"/> 
  </resource> 
  <resource> 
    <code value="MedicationAdministration"/> 
    <param value="performer"/> 
  </resource> 
  <resource> 
    <code value="MedicationDispense"/> 
  </resource> 
  <resource> 
    <code value="MedicationRequest"/> 
  </resource> 
  <resource> 
    <code value="MedicationStatement"/> 
    <param value="source"/> 
  </resource> 
  <resource> 
    <code value="MessageDefinition"/> 
  </resource> 
  <resource> 
    <code value="MessageHeader"/> 
  </resource> 
  <resource> 
    <code value="NamingSystem"/> 
  </resource> 
  <resource> 
    <code value="NutritionOrder"/> 
  </resource> 
  <resource> 
    <code value="Observation"/> 
    <param value="performer"/> 
  </resource> 
  <resource> 
    <code value="OperationDefinition"/> 
  </resource> 
  <resource> 
    <code value="OperationOutcome"/> 
  </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="link"/> 
  </resource> 
  <resource> 
    <code value="PlanDefinition"/> 
  </resource> 
  <resource> 
    <code value="Practitioner"/> 
  </resource> 
  <resource> 
    <code value="PractitionerRole"/> 
  </resource> 
  <resource> 
    <code value="Procedure"/> 
    <param value="performer"/> 
  </resource> 
  <resource> 
    <code value="ProcedureRequest"/> 
    <param value="performer"/> 
  </resource> 
  <resource> 
    <code value="ProcessRequest"/> 
  </resource> 
  <resource> 
    <code value="ProcessResponse"/> 
  </resource> 
  <resource> 
    <code value="Provenance"/> 
    <param value="agent"/> 
  </resource> 
  <resource> 
    <code value="Questionnaire"/> 
  </resource> 
  <resource> 
    <code value="QuestionnaireResponse"/> 
    <param value="author"/> 
    <param value="source"/> 
  </resource> 
  <resource> 
    <code value="ReferralRequest"/> 
  </resource> 
  <resource> 
    <code value="RelatedPerson"/> 
    <param value="{def}"/> 
  </resource> 
  <resource> 
    <code value="RequestGroup"/> 
    <param value="participant"/> 
  </resource> 
  <resource> 
    <code value="ResearchStudy"/> 
  </resource> 
  <resource> 
    <code value="ResearchSubject"/> 
  </resource> 
  <resource> 
    <code value="RiskAssessment"/> 
  </resource> 
  <resource> 
    <code value="Schedule"/> 
    <param value="actor"/> 
  </resource> 
  <resource> 
    <code value="SearchParameter"/> 
  </resource> 
  <resource> 
    <code value="Sequence"/> 
  </resource> 
  <resource> 
    <code value="ServiceDefinition"/> 
  </resource> 
  <resource> 
    <code value="Slot"/> 
  </resource> 
  <resource> 
    <code value="Specimen"/> 
  </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"/> 
  </resource> 
  <resource> 
    <code value="SupplyRequest"/> 
    <param value="requester"/> 
  </resource> 
  <resource> 
    <code value="Task"/> 
  </resource> 
  <resource> 
    <code value="TestReport"/> 
  </resource> 
  <resource> 
    <code value="TestScript"/> 
  </resource> 
  <resource> 
    <code value="ValueSet"/> 
  </resource> 
  <resource> 
    <code value="VisionPrescription"/> 
  </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.