Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). 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

Compartment Patient

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status:Trial Use
Formal URIhttp://hl7.org/fhir/compartment/Patient
DescriptionThe set of resources associated with a particular patient
IdentityThere 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 resource, the records associated with the linked patient resource will not be returned as part of the compartment search. Those records will be returned only with another compartment search using the "id" for the linked patient resource. In cases where two patients have been merged rather than linked, associated resources should be moved to the target patient as part of the merge process, so the patient compartment for the target patient would include all relevant data, and the patient compartment for the source patient would include only the linked Patient and possibly remnant resources like AuditEvent.
MembershipThe patient compartment includes any resources where the subject of the resource is the patient, and some other resources that are directly linked to resources in the patient compartment
Formal DefinitionCompartmentDefinitionresource: XML or JSON

Resource based membership rules.

The following resources may be in this compartment:

ResourceInclusion Criteria
Accountsubject
AdverseEventsubject
AllergyIntolerancepatient or participant
Appointmentactor
AppointmentResponseactor
AuditEventpatient
Basicpatient or author
BodyStructurepatient
CarePlanpatient or performer
CareTeampatient or participant
ChargeItemsubject
Claimpatient or payee
ClaimResponsepatient
ClinicalImpressionsubject
Communicationsubject or sender or recipient
CommunicationRequestsubject or information-provider or recipient or requester
Compositionsubject or author or attester
Conditionpatient or participant-actor
Consentsubject
Coveragepolicy-holder or subscriber or beneficiary or paymentby-party
CoverageEligibilityRequestpatient
CoverageEligibilityResponsepatient
DetectedIssuepatient
Devicesubject
DeviceRequestsubject or performer
DeviceUsagepatient
DiagnosticReportsubject
DocumentManifestsubject or author or recipient
DocumentReferencesubject or author
Encounterpatient
EnrollmentRequestsubject
EpisodeOfCarepatient
ExplanationOfBenefitpatient or payee
FamilyMemberHistorypatient
Flagpatient
GenomicStudypatient
Goalpatient
Groupmember
ImagingSelectionpatient
ImagingStudypatient
Immunizationpatient
ImmunizationEvaluationpatient
ImmunizationRecommendationpatient
Invoicesubject or patient or recipient
Listsubject or source
MeasureReportpatient
MedicationAdministrationpatient or performer or subject
MedicationDispensesubject or patient or receiver
MedicationRequestsubject
MedicationUsagesubject
MolecularSequencesubject
NutritionIntakesubject or source
NutritionOrderpatient
Observationsubject or performer
Patient[base] or link
Personpatient
Procedurepatient or performer
Provenancepatient
QuestionnaireResponsesubject or author
RelatedPersonpatient
RequestOrchestrationsubject or participant
ResearchSubjectsubject
RiskAssessmentsubject
Scheduleactor
ServiceRequestsubject or performer
Specimensubject
SupplyDeliverypatient
SupplyRequestsubject
VisionPrescriptionpatient

A resource is in this compartment if the nominated search parameter (or chain) refers to the compartmentdefinition-patient resource that defines the compartment.

All resources not explicitly listed above are not defined as part of the compartment because they do not have a relevant element, or an appropriate specified search parameter. Some non-listed resources may still be relevant for certain compartment uses, such as access control - e.g. Binary.

See information about compartments.