This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions
FHIR Infrastructure Work Group | Maturity Level: N/A | Standards Status: Informative |
Raw JSON (canonical form + also see JSON Format Specification)
Compartment Definition for relatedPerson
{ "resourceType" : "CompartmentDefinition", "id" : "relatedPerson", "text" : { "status" : "generated", "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CompartmentDefinition relatedPerson</b></p><a name=\"relatedPerson\"> </a><a name=\"hcrelatedPerson\"> </a><a name=\"relatedPerson-en-US\"> </a><p>\r\nThe following resources may be in this compartment:\r\n</p>\r\n<table class=\"grid\">\r\n <tr><td><b>Resource</b></td><td><b>Inclusion Criteria</b></td></tr>\r\n <tr><td><a href=\"adverseevent.html\">AdverseEvent</a></td><td>recorder</td></tr>\r\n <tr><td><a href=\"allergyintolerance.html\">AllergyIntolerance</a></td><td>asserter</td></tr>\r\n <tr><td><a href=\"appointment.html\">Appointment</a></td><td>actor</td></tr>\r\n <tr><td><a href=\"appointmentresponse.html\">AppointmentResponse</a></td><td>actor</td></tr>\r\n <tr><td><a href=\"basic.html\">Basic</a></td><td>author</td></tr>\r\n <tr><td><a href=\"careteam.html\">CareTeam</a></td><td>participant</td></tr>\r\n <tr><td><a href=\"chargeitem.html\">ChargeItem</a></td><td>enterer, performer-actor</td></tr>\r\n <tr><td><a href=\"claim.html\">Claim</a></td><td>payee</td></tr>\r\n <tr><td><a href=\"communication.html\">Communication</a></td><td>sender, recipient</td></tr>\r\n <tr><td><a href=\"communicationrequest.html\">CommunicationRequest</a></td><td>information-provider, recipient, requester</td></tr>\r\n <tr><td><a href=\"composition.html\">Composition</a></td><td>author</td></tr>\r\n <tr><td><a href=\"condition.html\">Condition</a></td><td>asserter</td></tr>\r\n <tr><td><a href=\"coverage.html\">Coverage</a></td><td>policy-holder, subscriber, paymentby-party</td></tr>\r\n <tr><td><a href=\"documentreference.html\">DocumentReference</a></td><td>author</td></tr>\r\n <tr><td><a href=\"encounter.html\">Encounter</a></td><td>participant</td></tr>\r\n <tr><td><a href=\"explanationofbenefit.html\">ExplanationOfBenefit</a></td><td>payee</td></tr>\r\n <tr><td><a href=\"invoice.html\">Invoice</a></td><td>recipient</td></tr>\r\n <tr><td><a href=\"medicationstatement.html\">MedicationStatement</a></td><td>source</td></tr>\r\n <tr><td><a href=\"nutritionintake.html\">NutritionIntake</a></td><td>source</td></tr>\r\n <tr><td><a href=\"observation.html\">Observation</a></td><td>performer</td></tr>\r\n <tr><td><a href=\"patient.html\">Patient</a></td><td>link</td></tr>\r\n <tr><td><a href=\"person.html\">Person</a></td><td>link</td></tr>\r\n <tr><td><a href=\"personalrelationship.html\">PersonalRelationship</a></td><td>source, target</td></tr>\r\n <tr><td><a href=\"procedure.html\">Procedure</a></td><td>performer</td></tr>\r\n <tr><td><a href=\"provenance.html\">Provenance</a></td><td>agent</td></tr>\r\n <tr><td><a href=\"questionnaireresponse.html\">QuestionnaireResponse</a></td><td>author, source</td></tr>\r\n <tr><td><a href=\"relatedperson.html\">RelatedPerson</a></td><td>{def}</td></tr>\r\n <tr><td><a href=\"requestorchestration.html\">RequestOrchestration</a></td><td>participant</td></tr>\r\n <tr><td><a href=\"schedule.html\">Schedule</a></td><td>actor</td></tr>\r\n <tr><td><a href=\"servicerequest.html\">ServiceRequest</a></td><td>performer</td></tr>\r\n <tr><td><a href=\"supplyrequest.html\">SupplyRequest</a></td><td>requester</td></tr>\r\n</table>\r\n<p>\r\nA resource is in this compartment if the nominated search parameter (or chain) refers to the patient resource that defines the compartment.\r\n</p>\r\n<p>\r\n\r\n</p>\r\n<p>\r\nThe following resources are never in this compartment:\r\n</p>\r\n<ul>\r\n <li><a href=\"account.html\">Account</a></li>\r\n <li><a href=\"activitydefinition.html\">ActivityDefinition</a></li>\r\n <li><a href=\"actordefinition.html\">ActorDefinition</a></li>\r\n <li><a href=\"administrableproductdefinition.html\">AdministrableProductDefinition</a></li>\r\n <li><a href=\"artifactassessment.html\">ArtifactAssessment</a></li>\r\n <li><a href=\"auditevent.html\">AuditEvent</a></li>\r\n <li><a href=\"binary.html\">Binary</a></li>\r\n <li><a href=\"biologicallyderivedproduct.html\">BiologicallyDerivedProduct</a></li>\r\n <li><a href=\"biologicallyderivedproductdispense.html\">BiologicallyDerivedProductDispense</a></li>\r\n <li><a href=\"bodystructure.html\">BodyStructure</a></li>\r\n <li><a href=\"bundle.html\">Bundle</a></li>\r\n <li><a href=\"capabilitystatement.html\">CapabilityStatement</a></li>\r\n <li><a href=\"careplan.html\">CarePlan</a></li>\r\n <li><a href=\"chargeitemdefinition.html\">ChargeItemDefinition</a></li>\r\n <li><a href=\"citation.html\">Citation</a></li>\r\n <li><a href=\"claimresponse.html\">ClaimResponse</a></li>\r\n <li><a href=\"clinicalimpression.html\">ClinicalImpression</a></li>\r\n <li><a href=\"clinicalusedefinition.html\">ClinicalUseDefinition</a></li>\r\n <li><a href=\"codesystem.html\">CodeSystem</a></li>\r\n <li><a href=\"compartmentdefinition.html\">CompartmentDefinition</a></li>\r\n <li><a href=\"conceptmap.html\">ConceptMap</a></li>\r\n <li><a href=\"conditiondefinition.html\">ConditionDefinition</a></li>\r\n <li><a href=\"consent.html\">Consent</a></li>\r\n <li><a href=\"contract.html\">Contract</a></li>\r\n <li><a href=\"coverageeligibilityrequest.html\">CoverageEligibilityRequest</a></li>\r\n <li><a href=\"coverageeligibilityresponse.html\">CoverageEligibilityResponse</a></li>\r\n <li><a href=\"detectedissue.html\">DetectedIssue</a></li>\r\n <li><a href=\"device.html\">Device</a></li>\r\n <li><a href=\"devicealert.html\">DeviceAlert</a></li>\r\n <li><a href=\"deviceassociation.html\">DeviceAssociation</a></li>\r\n <li><a href=\"devicedefinition.html\">DeviceDefinition</a></li>\r\n <li><a href=\"devicedispense.html\">DeviceDispense</a></li>\r\n <li><a href=\"devicemetric.html\">DeviceMetric</a></li>\r\n <li><a href=\"devicerequest.html\">DeviceRequest</a></li>\r\n <li><a href=\"deviceusage.html\">DeviceUsage</a></li>\r\n <li><a href=\"diagnosticreport.html\">DiagnosticReport</a></li>\r\n <li><a href=\"encounterhistory.html\">EncounterHistory</a></li>\r\n <li><a href=\"endpoint.html\">Endpoint</a></li>\r\n <li><a href=\"enrollmentrequest.html\">EnrollmentRequest</a></li>\r\n <li><a href=\"enrollmentresponse.html\">EnrollmentResponse</a></li>\r\n <li><a href=\"episodeofcare.html\">EpisodeOfCare</a></li>\r\n <li><a href=\"eventdefinition.html\">EventDefinition</a></li>\r\n <li><a href=\"evidence.html\">Evidence</a></li>\r\n <li><a href=\"evidencereport.html\">EvidenceReport</a></li>\r\n <li><a href=\"evidencevariable.html\">EvidenceVariable</a></li>\r\n <li><a href=\"examplescenario.html\">ExampleScenario</a></li>\r\n <li><a href=\"familymemberhistory.html\">FamilyMemberHistory</a></li>\r\n <li><a href=\"flag.html\">Flag</a></li>\r\n <li><a href=\"formularyitem.html\">FormularyItem</a></li>\r\n <li><a href=\"genomicstudy.html\">GenomicStudy</a></li>\r\n <li><a href=\"goal.html\">Goal</a></li>\r\n <li><a href=\"graphdefinition.html\">GraphDefinition</a></li>\r\n <li><a href=\"group.html\">Group</a></li>\r\n <li><a href=\"guidanceresponse.html\">GuidanceResponse</a></li>\r\n <li><a href=\"healthcareservice.html\">HealthcareService</a></li>\r\n <li><a href=\"imagingselection.html\">ImagingSelection</a></li>\r\n <li><a href=\"imagingstudy.html\">ImagingStudy</a></li>\r\n <li><a href=\"immunization.html\">Immunization</a></li>\r\n <li><a href=\"immunizationevaluation.html\">ImmunizationEvaluation</a></li>\r\n <li><a href=\"immunizationrecommendation.html\">ImmunizationRecommendation</a></li>\r\n <li><a href=\"implementationguide.html\">ImplementationGuide</a></li>\r\n <li><a href=\"ingredient.html\">Ingredient</a></li>\r\n <li><a href=\"insuranceplan.html\">InsurancePlan</a></li>\r\n <li><a href=\"insuranceproduct.html\">InsuranceProduct</a></li>\r\n <li><a href=\"inventoryitem.html\">InventoryItem</a></li>\r\n <li><a href=\"inventoryreport.html\">InventoryReport</a></li>\r\n <li><a href=\"library.html\">Library</a></li>\r\n <li><a href=\"linkage.html\">Linkage</a></li>\r\n <li><a href=\"list.html\">List</a></li>\r\n <li><a href=\"location.html\">Location</a></li>\r\n <li><a href=\"manufactureditemdefinition.html\">ManufacturedItemDefinition</a></li>\r\n <li><a href=\"measure.html\">Measure</a></li>\r\n <li><a href=\"measurereport.html\">MeasureReport</a></li>\r\n <li><a href=\"medication.html\">Medication</a></li>\r\n <li><a href=\"medicationadministration.html\">MedicationAdministration</a></li>\r\n <li><a href=\"medicationdispense.html\">MedicationDispense</a></li>\r\n <li><a href=\"medicationknowledge.html\">MedicationKnowledge</a></li>\r\n <li><a href=\"medicationrequest.html\">MedicationRequest</a></li>\r\n <li><a href=\"medicinalproductdefinition.html\">MedicinalProductDefinition</a></li>\r\n <li><a href=\"messagedefinition.html\">MessageDefinition</a></li>\r\n <li><a href=\"messageheader.html\">MessageHeader</a></li>\r\n <li><a href=\"moleculardefinition.html\">MolecularDefinition</a></li>\r\n <li><a href=\"molecularsequence.html\">MolecularSequence</a></li>\r\n <li><a href=\"namingsystem.html\">NamingSystem</a></li>\r\n <li><a href=\"nutritionorder.html\">NutritionOrder</a></li>\r\n <li><a href=\"nutritionproduct.html\">NutritionProduct</a></li>\r\n <li><a href=\"observationdefinition.html\">ObservationDefinition</a></li>\r\n <li><a href=\"operationdefinition.html\">OperationDefinition</a></li>\r\n <li><a href=\"operationoutcome.html\">OperationOutcome</a></li>\r\n <li><a href=\"organization.html\">Organization</a></li>\r\n <li><a href=\"organizationaffiliation.html\">OrganizationAffiliation</a></li>\r\n <li><a href=\"packagedproductdefinition.html\">PackagedProductDefinition</a></li>\r\n <li><a href=\"paymentnotice.html\">PaymentNotice</a></li>\r\n <li><a href=\"paymentreconciliation.html\">PaymentReconciliation</a></li>\r\n <li><a href=\"permission.html\">Permission</a></li>\r\n <li><a href=\"plandefinition.html\">PlanDefinition</a></li>\r\n <li><a href=\"practitioner.html\">Practitioner</a></li>\r\n <li><a href=\"practitionerrole.html\">PractitionerRole</a></li>\r\n <li><a href=\"questionnaire.html\">Questionnaire</a></li>\r\n <li><a href=\"regulatedauthorization.html\">RegulatedAuthorization</a></li>\r\n <li><a href=\"requirements.html\">Requirements</a></li>\r\n <li><a href=\"researchstudy.html\">ResearchStudy</a></li>\r\n <li><a href=\"researchsubject.html\">ResearchSubject</a></li>\r\n <li><a href=\"riskassessment.html\">RiskAssessment</a></li>\r\n <li><a href=\"searchparameter.html\">SearchParameter</a></li>\r\n <li><a href=\"slot.html\">Slot</a></li>\r\n <li><a href=\"specimen.html\">Specimen</a></li>\r\n <li><a href=\"specimendefinition.html\">SpecimenDefinition</a></li>\r\n <li><a href=\"structuredefinition.html\">StructureDefinition</a></li>\r\n <li><a href=\"structuremap.html\">StructureMap</a></li>\r\n <li><a href=\"subscription.html\">Subscription</a></li>\r\n <li><a href=\"subscriptionstatus.html\">SubscriptionStatus</a></li>\r\n <li><a href=\"subscriptiontopic.html\">SubscriptionTopic</a></li>\r\n <li><a href=\"substance.html\">Substance</a></li>\r\n <li><a href=\"substancedefinition.html\">SubstanceDefinition</a></li>\r\n <li><a href=\"substancenucleicacid.html\">SubstanceNucleicAcid</a></li>\r\n <li><a href=\"substancepolymer.html\">SubstancePolymer</a></li>\r\n <li><a href=\"substanceprotein.html\">SubstanceProtein</a></li>\r\n <li><a href=\"substancereferenceinformation.html\">SubstanceReferenceInformation</a></li>\r\n <li><a href=\"substancesourcematerial.html\">SubstanceSourceMaterial</a></li>\r\n <li><a href=\"supplydelivery.html\">SupplyDelivery</a></li>\r\n <li><a href=\"task.html\">Task</a></li>\r\n <li><a href=\"terminologycapabilities.html\">TerminologyCapabilities</a></li>\r\n <li><a href=\"testplan.html\">TestPlan</a></li>\r\n <li><a href=\"testreport.html\">TestReport</a></li>\r\n <li><a href=\"testscript.html\">TestScript</a></li>\r\n <li><a href=\"transport.html\">Transport</a></li>\r\n <li><a href=\"valueset.html\">ValueSet</a></li>\r\n <li><a href=\"verificationresult.html\">VerificationResult</a></li>\r\n <li><a href=\"visionprescription.html\">VisionPrescription</a></li>\r\n</ul></div>" }, "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode" : "fhir" }], "url" : "http://hl7.org/fhir/CompartmentDefinition/relatedPerson", "version" : "6.0.0-ballot2", "name" : "Base FHIR compartment definition for RelatedPerson", "status" : "draft", "experimental" : true, "date" : "2024-11-12T02:57:08+00:00", "publisher" : "HL7 International / FHIR Infrastructure", "contact" : [{ "telecom" : [{ "system" : "url", "value" : "http://www.hl7.org/Special/committees/fiwg" }] }], "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" : ["asserter"] }, { "code" : "Appointment", "param" : ["actor"] }, { "code" : "AppointmentResponse", "param" : ["actor"] }, { "code" : "ArtifactAssessment" }, { "code" : "AuditEvent" }, { "code" : "Basic", "param" : ["author"] }, { "code" : "Binary" }, { "code" : "BiologicallyDerivedProduct" }, { "code" : "BiologicallyDerivedProductDispense" }, { "code" : "BodyStructure" }, { "code" : "Bundle" }, { "code" : "CapabilityStatement" }, { "code" : "CarePlan" }, { "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" : ["asserter"] }, { "code" : "ConditionDefinition" }, { "code" : "Consent" }, { "code" : "Contract" }, { "code" : "Coverage", "param" : ["policy-holder", "subscriber", "paymentby-party"] }, { "code" : "CoverageEligibilityRequest" }, { "code" : "CoverageEligibilityResponse" }, { "code" : "DetectedIssue" }, { "code" : "Device" }, { "code" : "DeviceAlert" }, { "code" : "DeviceAssociation" }, { "code" : "DeviceDefinition" }, { "code" : "DeviceDispense" }, { "code" : "DeviceMetric" }, { "code" : "DeviceRequest" }, { "code" : "DeviceUsage" }, { "code" : "DiagnosticReport" }, { "code" : "DocumentReference", "param" : ["author"] }, { "code" : "Encounter", "param" : ["participant"] }, { "code" : "EncounterHistory" }, { "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" : "InsuranceProduct" }, { "code" : "InventoryItem" }, { "code" : "InventoryReport" }, { "code" : "Invoice", "param" : ["recipient"] }, { "code" : "Library" }, { "code" : "Linkage" }, { "code" : "List" }, { "code" : "Location" }, { "code" : "ManufacturedItemDefinition" }, { "code" : "Measure" }, { "code" : "MeasureReport" }, { "code" : "Medication" }, { "code" : "MedicationAdministration" }, { "code" : "MedicationDispense" }, { "code" : "MedicationKnowledge" }, { "code" : "MedicationRequest" }, { "code" : "MedicationStatement", "param" : ["source"] }, { "code" : "MedicinalProductDefinition" }, { "code" : "MessageDefinition" }, { "code" : "MessageHeader" }, { "code" : "MolecularDefinition" }, { "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" : "PersonalRelationship", "param" : ["source", "target"] }, { "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" : "TestPlan" }, { "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.
FHIR ®© HL7.org 2011+. FHIR R6 hl7.fhir.core#6.0.0-ballot2 generated on Tue, Nov 12, 2024 03:26+0000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R5 |
|
Propose a change