Release 5 Ballot

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

Example CompartmentDefinition/relatedPerson (JSON)

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

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

Compartment Definition for relatedPerson

{
  "resourceType" : "CompartmentDefinition",
  "id" : "relatedPerson",
  "text" : {
    "status" : "extensions",
    "div" : "<div>!-- Snipped for Brevity --></div>"
  },
  "url" : "http://hl7.org/fhir/CompartmentDefinition/relatedPerson",
  "version" : "5.0.0-ballot",
  "name" : "Base FHIR compartment definition for RelatedPerson",
  "status" : "draft",
  "experimental" : true,
  "date" : "2022-09-07T10:58:29+10:00",
  "publisher" : "FHIR Project Team",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    }]
  }],
  "description" : "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" : "RelatedPerson",
  "search" : true,
  "resource" : [{
    "code" : "Account"
  },
  {
    "code" : "ActivityDefinition"
  },
  {
    "code" : "ActorDefinition"
  },
  {
    "code" : "AdministrableProductDefinition"
  },
  {
    "code" : "AdverseEvent",
    "param" : ["recorder"]
  },
  {
    "code" : "AllergyIntolerance",
    "param" : ["participant"]
  },
  {
    "code" : "Appointment",
    "param" : ["actor"]
  },
  {
    "code" : "AppointmentResponse",
    "param" : ["actor"]
  },
  {
    "code" : "ArtifactAssessment"
  },
  {
    "code" : "AuditEvent"
  },
  {
    "code" : "Basic",
    "param" : ["author"]
  },
  {
    "code" : "Binary"
  },
  {
    "code" : "BiologicallyDerivedProduct"
  },
  {
    "code" : "BodyStructure"
  },
  {
    "code" : "Bundle"
  },
  {
    "code" : "CapabilityStatement"
  },
  {
    "code" : "CarePlan",
    "param" : ["performer"]
  },
  {
    "code" : "CareTeam",
    "param" : ["participant"]
  },
  {
    "code" : "ChargeItem",
    "param" : ["enterer",
    "performer-actor"]
  },
  {
    "code" : "ChargeItemDefinition"
  },
  {
    "code" : "Citation"
  },
  {
    "code" : "Claim",
    "param" : ["payee"]
  },
  {
    "code" : "ClaimResponse"
  },
  {
    "code" : "ClinicalImpression"
  },
  {
    "code" : "ClinicalUseDefinition"
  },
  {
    "code" : "CodeSystem"
  },
  {
    "code" : "Communication",
    "param" : ["sender",
    "recipient"]
  },
  {
    "code" : "CommunicationRequest",
    "param" : ["information-provider",
    "recipient",
    "requester"]
  },
  {
    "code" : "CompartmentDefinition"
  },
  {
    "code" : "Composition",
    "param" : ["author"]
  },
  {
    "code" : "ConceptMap"
  },
  {
    "code" : "Condition",
    "param" : ["participant-actor"]
  },
  {
    "code" : "ConditionDefinition"
  },
  {
    "code" : "Consent"
  },
  {
    "code" : "Contract"
  },
  {
    "code" : "Coverage",
    "param" : ["policy-holder",
    "subscriber",
    "paymentby-party"]
  },
  {
    "code" : "CoverageEligibilityRequest"
  },
  {
    "code" : "CoverageEligibilityResponse"
  },
  {
    "code" : "DetectedIssue"
  },
  {
    "code" : "Device"
  },
  {
    "code" : "DeviceDefinition"
  },
  {
    "code" : "DeviceDispense"
  },
  {
    "code" : "DeviceMetric"
  },
  {
    "code" : "DeviceRequest"
  },
  {
    "code" : "DeviceUsage"
  },
  {
    "code" : "DiagnosticReport"
  },
  {
    "code" : "DocumentManifest",
    "param" : ["author",
    "recipient"]
  },
  {
    "code" : "DocumentReference",
    "param" : ["author"]
  },
  {
    "code" : "Encounter",
    "param" : ["participant"]
  },
  {
    "code" : "Endpoint"
  },
  {
    "code" : "EnrollmentRequest"
  },
  {
    "code" : "EnrollmentResponse"
  },
  {
    "code" : "EpisodeOfCare"
  },
  {
    "code" : "EventDefinition"
  },
  {
    "code" : "Evidence"
  },
  {
    "code" : "EvidenceReport"
  },
  {
    "code" : "EvidenceVariable"
  },
  {
    "code" : "ExampleScenario"
  },
  {
    "code" : "ExplanationOfBenefit",
    "param" : ["payee"]
  },
  {
    "code" : "FamilyMemberHistory"
  },
  {
    "code" : "Flag"
  },
  {
    "code" : "FormularyItem"
  },
  {
    "code" : "GenomicStudy"
  },
  {
    "code" : "Goal"
  },
  {
    "code" : "GraphDefinition"
  },
  {
    "code" : "Group"
  },
  {
    "code" : "GuidanceResponse"
  },
  {
    "code" : "HealthcareService"
  },
  {
    "code" : "ImagingSelection"
  },
  {
    "code" : "ImagingStudy"
  },
  {
    "code" : "Immunization"
  },
  {
    "code" : "ImmunizationEvaluation"
  },
  {
    "code" : "ImmunizationRecommendation"
  },
  {
    "code" : "ImplementationGuide"
  },
  {
    "code" : "Ingredient"
  },
  {
    "code" : "InsurancePlan"
  },
  {
    "code" : "InventoryReport"
  },
  {
    "code" : "Invoice",
    "param" : ["recipient"]
  },
  {
    "code" : "Library"
  },
  {
    "code" : "Linkage"
  },
  {
    "code" : "List"
  },
  {
    "code" : "Location"
  },
  {
    "code" : "ManufacturedItemDefinition"
  },
  {
    "code" : "Measure"
  },
  {
    "code" : "MeasureReport"
  },
  {
    "code" : "Medication"
  },
  {
    "code" : "MedicationAdministration",
    "param" : ["performer"]
  },
  {
    "code" : "MedicationDispense"
  },
  {
    "code" : "MedicationKnowledge"
  },
  {
    "code" : "MedicationRequest"
  },
  {
    "code" : "MedicationUsage",
    "param" : ["source"]
  },
  {
    "code" : "MedicinalProductDefinition"
  },
  {
    "code" : "MessageDefinition"
  },
  {
    "code" : "MessageHeader"
  },
  {
    "code" : "MolecularSequence"
  },
  {
    "code" : "NamingSystem"
  },
  {
    "code" : "NutritionIntake",
    "param" : ["source"]
  },
  {
    "code" : "NutritionOrder"
  },
  {
    "code" : "NutritionProduct"
  },
  {
    "code" : "Observation",
    "param" : ["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" : ["link"]
  },
  {
    "code" : "PlanDefinition"
  },
  {
    "code" : "Practitioner"
  },
  {
    "code" : "PractitionerRole"
  },
  {
    "code" : "Procedure",
    "param" : ["performer"]
  },
  {
    "code" : "Provenance",
    "param" : ["agent"]
  },
  {
    "code" : "Questionnaire"
  },
  {
    "code" : "QuestionnaireResponse",
    "param" : ["author",
    "source"]
  },
  {
    "code" : "RegulatedAuthorization"
  },
  {
    "code" : "RelatedPerson",
    "param" : ["{def}"]
  },
  {
    "code" : "RequestOrchestration",
    "param" : ["participant"]
  },
  {
    "code" : "Requirements"
  },
  {
    "code" : "ResearchStudy"
  },
  {
    "code" : "ResearchSubject"
  },
  {
    "code" : "RiskAssessment"
  },
  {
    "code" : "Schedule",
    "param" : ["actor"]
  },
  {
    "code" : "SearchParameter"
  },
  {
    "code" : "ServiceRequest",
    "param" : ["performer"]
  },
  {
    "code" : "Slot"
  },
  {
    "code" : "Specimen"
  },
  {
    "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"
  },
  {
    "code" : "SupplyRequest",
    "param" : ["requester"]
  },
  {
    "code" : "Task"
  },
  {
    "code" : "TerminologyCapabilities"
  },
  {
    "code" : "TestReport"
  },
  {
    "code" : "TestScript"
  },
  {
    "code" : "Transport"
  },
  {
    "code" : "ValueSet"
  },
  {
    "code" : "VerificationResult"
  },
  {
    "code" : "VisionPrescription"
  }]
}

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.