Release 5 Draft Ballot

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

Compartmentdefinition-patient.json

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

Raw JSON (canonical form + also see JSON Format Specification)

Compartment Definition for patient

{
  "resourceType" : "CompartmentDefinition",
  "id" : "patient",
  "text" : {
    "status" : "extensions",
    "div" : "<div>!-- Snipped for Brevity --></div>"
  },
  "url" : "http://hl7.org/fhir/CompartmentDefinition/patient",
  "version" : "4.6.0",
  "name" : "Base FHIR compartment definition for Patient",
  "status" : "draft",
  "experimental" : true,
  "date" : "2022-08-11T19:46:11+00:00",
  "publisher" : "FHIR Project Team",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    }]
  }],
  "description" : "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 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.\n \nIn 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.. The set of resources associated with a particular patient",
  "code" : "Patient",
  "search" : true,
  "resource" : [{
    "code" : "Account",
    "param" : ["subject"]
  },
  {
    "code" : "ActivityDefinition"
  },
  {
    "code" : "AdministrableProductDefinition"
  },
  {
    "code" : "AdverseEvent",
    "param" : ["subject"]
  },
  {
    "code" : "AllergyIntolerance",
    "param" : ["patient",
    "participant"]
  },
  {
    "code" : "Appointment",
    "param" : ["actor"]
  },
  {
    "code" : "AppointmentResponse",
    "param" : ["actor"]
  },
  {
    "code" : "ArtifactAssessment"
  },
  {
    "code" : "AuditEvent",
    "param" : ["patient"]
  },
  {
    "code" : "Basic",
    "param" : ["patient",
    "author"]
  },
  {
    "code" : "Binary"
  },
  {
    "code" : "BiologicallyDerivedProduct"
  },
  {
    "code" : "BodyStructure",
    "param" : ["patient"]
  },
  {
    "code" : "Bundle"
  },
  {
    "code" : "CapabilityStatement"
  },
  {
    "code" : "CarePlan",
    "param" : ["patient",
    "performer"]
  },
  {
    "code" : "CareTeam",
    "param" : ["patient",
    "participant"]
  },
  {
    "code" : "ChargeItem",
    "param" : ["subject"]
  },
  {
    "code" : "ChargeItemDefinition"
  },
  {
    "code" : "Citation"
  },
  {
    "code" : "Claim",
    "param" : ["patient",
    "payee"]
  },
  {
    "code" : "ClaimResponse",
    "param" : ["patient"]
  },
  {
    "code" : "ClinicalImpression",
    "param" : ["subject"]
  },
  {
    "code" : "ClinicalUseDefinition"
  },
  {
    "code" : "CodeSystem"
  },
  {
    "code" : "Communication",
    "param" : ["subject",
    "sender",
    "recipient"]
  },
  {
    "code" : "CommunicationRequest",
    "param" : ["subject",
    "information-provider",
    "recipient",
    "requester"]
  },
  {
    "code" : "CompartmentDefinition"
  },
  {
    "code" : "Composition",
    "param" : ["subject",
    "author",
    "attester"]
  },
  {
    "code" : "ConceptMap"
  },
  {
    "code" : "Condition",
    "param" : ["patient",
    "participant-actor"]
  },
  {
    "code" : "ConditionDefinition"
  },
  {
    "code" : "Consent",
    "param" : ["subject"]
  },
  {
    "code" : "Contract"
  },
  {
    "code" : "Coverage",
    "param" : ["policy-holder",
    "subscriber",
    "beneficiary"]
  },
  {
    "code" : "CoverageEligibilityRequest",
    "param" : ["patient"]
  },
  {
    "code" : "CoverageEligibilityResponse",
    "param" : ["patient"]
  },
  {
    "code" : "DetectedIssue",
    "param" : ["patient"]
  },
  {
    "code" : "Device",
    "param" : ["subject"]
  },
  {
    "code" : "DeviceDefinition"
  },
  {
    "code" : "DeviceDispense"
  },
  {
    "code" : "DeviceMetric"
  },
  {
    "code" : "DeviceRequest",
    "param" : ["subject",
    "performer"]
  },
  {
    "code" : "DeviceUsage",
    "param" : ["patient"]
  },
  {
    "code" : "DiagnosticReport",
    "param" : ["subject"]
  },
  {
    "code" : "DocumentManifest",
    "param" : ["subject",
    "author",
    "recipient"]
  },
  {
    "code" : "DocumentReference",
    "param" : ["subject",
    "author"]
  },
  {
    "code" : "Encounter",
    "param" : ["patient"]
  },
  {
    "code" : "Endpoint"
  },
  {
    "code" : "EnrollmentRequest",
    "param" : ["subject"]
  },
  {
    "code" : "EnrollmentResponse"
  },
  {
    "code" : "EpisodeOfCare",
    "param" : ["patient"]
  },
  {
    "code" : "EventDefinition"
  },
  {
    "code" : "Evidence"
  },
  {
    "code" : "EvidenceReport"
  },
  {
    "code" : "EvidenceVariable"
  },
  {
    "code" : "ExampleScenario"
  },
  {
    "code" : "ExplanationOfBenefit",
    "param" : ["patient",
    "payee"]
  },
  {
    "code" : "FamilyMemberHistory",
    "param" : ["patient"]
  },
  {
    "code" : "Flag",
    "param" : ["patient"]
  },
  {
    "code" : "FormularyItem"
  },
  {
    "code" : "GenomicStudy",
    "param" : ["patient"]
  },
  {
    "code" : "Goal",
    "param" : ["patient"]
  },
  {
    "code" : "GraphDefinition"
  },
  {
    "code" : "Group",
    "param" : ["member"]
  },
  {
    "code" : "GuidanceResponse"
  },
  {
    "code" : "HealthcareService"
  },
  {
    "code" : "ImagingSelection",
    "param" : ["patient"]
  },
  {
    "code" : "ImagingStudy",
    "param" : ["patient"]
  },
  {
    "code" : "Immunization",
    "param" : ["patient"]
  },
  {
    "code" : "ImmunizationEvaluation",
    "param" : ["patient"]
  },
  {
    "code" : "ImmunizationRecommendation",
    "param" : ["patient"]
  },
  {
    "code" : "ImplementationGuide"
  },
  {
    "code" : "Ingredient"
  },
  {
    "code" : "InsurancePlan"
  },
  {
    "code" : "InventoryReport"
  },
  {
    "code" : "Invoice",
    "param" : ["subject",
    "patient",
    "recipient"]
  },
  {
    "code" : "Library"
  },
  {
    "code" : "Linkage"
  },
  {
    "code" : "List",
    "param" : ["subject",
    "source"]
  },
  {
    "code" : "Location"
  },
  {
    "code" : "ManufacturedItemDefinition"
  },
  {
    "code" : "Measure"
  },
  {
    "code" : "MeasureReport",
    "param" : ["patient"]
  },
  {
    "code" : "Medication"
  },
  {
    "code" : "MedicationAdministration",
    "param" : ["patient",
    "performer",
    "subject"]
  },
  {
    "code" : "MedicationDispense",
    "param" : ["subject",
    "patient",
    "receiver"]
  },
  {
    "code" : "MedicationKnowledge"
  },
  {
    "code" : "MedicationRequest",
    "param" : ["subject"]
  },
  {
    "code" : "MedicationUsage",
    "param" : ["subject"]
  },
  {
    "code" : "MedicinalProductDefinition"
  },
  {
    "code" : "MessageDefinition"
  },
  {
    "code" : "MessageHeader"
  },
  {
    "code" : "MolecularSequence",
    "param" : ["patient"]
  },
  {
    "code" : "NamingSystem"
  },
  {
    "code" : "NutritionIntake",
    "param" : ["subject",
    "source"]
  },
  {
    "code" : "NutritionOrder",
    "param" : ["patient"]
  },
  {
    "code" : "NutritionProduct"
  },
  {
    "code" : "Observation",
    "param" : ["subject",
    "performer"]
  },
  {
    "code" : "ObservationDefinition"
  },
  {
    "code" : "OperationDefinition"
  },
  {
    "code" : "OperationOutcome"
  },
  {
    "code" : "Organization"
  },
  {
    "code" : "OrganizationAffiliation"
  },
  {
    "code" : "PackagedProductDefinition"
  },
  {
    "code" : "Patient",
    "param" : ["link"]
  },
  {
    "code" : "PaymentNotice"
  },
  {
    "code" : "PaymentReconciliation"
  },
  {
    "code" : "Permission"
  },
  {
    "code" : "Person",
    "param" : ["patient"]
  },
  {
    "code" : "PlanDefinition"
  },
  {
    "code" : "Practitioner"
  },
  {
    "code" : "PractitionerRole"
  },
  {
    "code" : "Procedure",
    "param" : ["patient",
    "performer"]
  },
  {
    "code" : "Provenance",
    "param" : ["patient"]
  },
  {
    "code" : "Questionnaire"
  },
  {
    "code" : "QuestionnaireResponse",
    "param" : ["subject",
    "author"]
  },
  {
    "code" : "RegulatedAuthorization"
  },
  {
    "code" : "RelatedPerson",
    "param" : ["patient"]
  },
  {
    "code" : "RequestGroup",
    "param" : ["subject",
    "participant"]
  },
  {
    "code" : "ResearchStudy"
  },
  {
    "code" : "ResearchSubject",
    "param" : ["subject"]
  },
  {
    "code" : "RiskAssessment",
    "param" : ["subject"]
  },
  {
    "code" : "Schedule",
    "param" : ["actor"]
  },
  {
    "code" : "SearchParameter"
  },
  {
    "code" : "ServiceRequest",
    "param" : ["subject",
    "performer"]
  },
  {
    "code" : "Slot"
  },
  {
    "code" : "Specimen",
    "param" : ["subject"]
  },
  {
    "code" : "SpecimenDefinition"
  },
  {
    "code" : "StructureDefinition"
  },
  {
    "code" : "StructureMap"
  },
  {
    "code" : "Subscription"
  },
  {
    "code" : "SubscriptionStatus"
  },
  {
    "code" : "SubscriptionTopic"
  },
  {
    "code" : "Substance"
  },
  {
    "code" : "SubstanceDefinition"
  },
  {
    "code" : "SubstanceNucleicAcid"
  },
  {
    "code" : "SubstancePolymer"
  },
  {
    "code" : "SubstanceProtein"
  },
  {
    "code" : "SubstanceReferenceInformation"
  },
  {
    "code" : "SubstanceSourceMaterial"
  },
  {
    "code" : "SupplyDelivery",
    "param" : ["patient"]
  },
  {
    "code" : "SupplyRequest",
    "param" : ["subject"]
  },
  {
    "code" : "Task"
  },
  {
    "code" : "TerminologyCapabilities"
  },
  {
    "code" : "TestReport"
  },
  {
    "code" : "TestScript"
  },
  {
    "code" : "Transport"
  },
  {
    "code" : "ValueSet"
  },
  {
    "code" : "VerificationResult"
  },
  {
    "code" : "VisionPrescription",
    "param" : ["patient"]
  }]
}

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.