ConformanceThis 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 group
{
"resourceType" : "CompartmentDefinition",
"id" : "group",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CompartmentDefinition group</b></p><a name=\"group\"> </a><a name=\"hcgroup\"> </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>subject</td></tr>\r\n <tr><td><a href=\"appointment.html\">Appointment</a></td><td>subject, actor</td></tr>\r\n <tr><td><a href=\"appointmentresponse.html\">AppointmentResponse</a></td><td>actor</td></tr>\r\n <tr><td><a href=\"auditevent.html\">AuditEvent</a></td><td>agent</td></tr>\r\n <tr><td><a href=\"biologicallyderivedproductdispense.html\">BiologicallyDerivedProductDispense</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"careplan.html\">CarePlan</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"careteam.html\">CareTeam</a></td><td>subject, participant</td></tr>\r\n <tr><td><a href=\"chargeitem.html\">ChargeItem</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"clinicalassessment.html\">ClinicalAssessment</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"communication.html\">Communication</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"communicationrequest.html\">CommunicationRequest</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"condition.html\">Condition</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"consent.html\">Consent</a></td><td>subject, actor, grantee</td></tr>\r\n <tr><td><a href=\"detectedissue.html\">DetectedIssue</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"deviceassociation.html\">DeviceAssociation</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"devicedispense.html\">DeviceDispense</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"devicerequest.html\">DeviceRequest</a></td><td>subject, requester</td></tr>\r\n <tr><td><a href=\"deviceusage.html\">DeviceUsage</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"diagnosticreport.html\">DiagnosticReport</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"documentreference.html\">DocumentReference</a></td><td>attester, author, subject</td></tr>\r\n <tr><td><a href=\"encounter.html\">Encounter</a></td><td>subject, participant</td></tr>\r\n <tr><td><a href=\"encounterhistory.html\">EncounterHistory</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"enrollmentrequest.html\">EnrollmentRequest</a></td><td>group</td></tr>\r\n <tr><td><a href=\"enrollmentresponse.html\">EnrollmentResponse</a></td><td>group</td></tr>\r\n <tr><td><a href=\"episodeofcare.html\">EpisodeOfCare</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"flag.html\">Flag</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"genomicstudy.html\">GenomicStudy</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"goal.html\">Goal</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"guidanceresponse.html\">GuidanceResponse</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"imagingselection.html\">ImagingSelection</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"imagingstudy.html\">ImagingStudy</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"inventoryitem.html\">InventoryItem</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"invoice.html\">Invoice</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"measurereport.html\">MeasureReport</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"medicationadministration.html\">MedicationAdministration</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"medicationdispense.html\">MedicationDispense</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"medicationrequest.html\">MedicationRequest</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"medicationstatement.html\">MedicationStatement</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"nutritionintake.html\">NutritionIntake</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"nutritionorder.html\">NutritionOrder</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"observation.html\">Observation</a></td><td>specimen, subject, performer</td></tr>\r\n <tr><td><a href=\"procedure.html\">Procedure</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"provenance.html\">Provenance</a></td><td>agent</td></tr>\r\n <tr><td><a href=\"requestorchestration.html\">RequestOrchestration</a></td><td>participant, subject</td></tr>\r\n <tr><td><a href=\"researchstudy.html\">ResearchStudy</a></td><td>eligibility</td></tr>\r\n <tr><td><a href=\"researchsubject.html\">ResearchSubject</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"riskassessment.html\">RiskAssessment</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"servicerequest.html\">ServiceRequest</a></td><td>subject, performer</td></tr>\r\n <tr><td><a href=\"specimen.html\">Specimen</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"supplydelivery.html\">SupplyDelivery</a></td><td>subject, receiver</td></tr>\r\n <tr><td><a href=\"task.html\">Task</a></td><td>subject</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=\"allergyintolerance.html\">AllergyIntolerance</a></li>\r\n <li><a href=\"artifactassessment.html\">ArtifactAssessment</a></li>\r\n <li><a href=\"basic.html\">Basic</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=\"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=\"chargeitemdefinition.html\">ChargeItemDefinition</a></li>\r\n <li><a href=\"citation.html\">Citation</a></li>\r\n <li><a href=\"claim.html\">Claim</a></li>\r\n <li><a href=\"claimresponse.html\">ClaimResponse</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=\"composition.html\">Composition</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=\"contract.html\">Contract</a></li>\r\n <li><a href=\"coverage.html\">Coverage</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=\"device.html\">Device</a></li>\r\n <li><a href=\"devicealert.html\">DeviceAlert</a></li>\r\n <li><a href=\"devicedefinition.html\">DeviceDefinition</a></li>\r\n <li><a href=\"devicemetric.html\">DeviceMetric</a></li>\r\n <li><a href=\"endpoint.html\">Endpoint</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=\"evidencevariable.html\">EvidenceVariable</a></li>\r\n <li><a href=\"examplescenario.html\">ExampleScenario</a></li>\r\n <li><a href=\"explanationofbenefit.html\">ExplanationOfBenefit</a></li>\r\n <li><a href=\"familymemberhistory.html\">FamilyMemberHistory</a></li>\r\n <li><a href=\"formularyitem.html\">FormularyItem</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=\"healthcareservice.html\">HealthcareService</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=\"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=\"medication.html\">Medication</a></li>\r\n <li><a href=\"medicationknowledge.html\">MedicationKnowledge</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=\"namingsystem.html\">NamingSystem</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=\"patient.html\">Patient</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=\"person.html\">Person</a></li>\r\n <li><a href=\"personalrelationship.html\">PersonalRelationship</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=\"questionnaireresponse.html\">QuestionnaireResponse</a></li>\r\n <li><a href=\"regulatedauthorization.html\">RegulatedAuthorization</a></li>\r\n <li><a href=\"relatedperson.html\">RelatedPerson</a></li>\r\n <li><a href=\"requirements.html\">Requirements</a></li>\r\n <li><a href=\"schedule.html\">Schedule</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=\"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=\"supplyrequest.html\">SupplyRequest</a></li>\r\n <li><a href=\"terminologycapabilities.html\">TerminologyCapabilities</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/group",
"version" : "6.0.0-ballot3",
"name" : "Base FHIR compartment definition for Group",
"status" : "draft",
"experimental" : false,
"date" : "2025-10-24T06:05:48+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 group compartment for each Group resource, and the identity of the compartment is the same as the Group. The set of resources associated with a particular group",
"code" : "Group",
"search" : true,
"resource" : [{
"code" : "Account"
},
{
"code" : "ActivityDefinition"
},
{
"code" : "ActorDefinition"
},
{
"code" : "AdministrableProductDefinition"
},
{
"code" : "AdverseEvent",
"param" : ["subject"]
},
{
"code" : "AllergyIntolerance"
},
{
"code" : "Appointment",
"param" : ["subject",
"actor"]
},
{
"code" : "AppointmentResponse",
"param" : ["actor"]
},
{
"code" : "ArtifactAssessment"
},
{
"code" : "AuditEvent",
"param" : ["agent"]
},
{
"code" : "Basic"
},
{
"code" : "Binary"
},
{
"code" : "BiologicallyDerivedProduct"
},
{
"code" : "BiologicallyDerivedProductDispense",
"param" : ["subject"]
},
{
"code" : "BodyStructure"
},
{
"code" : "Bundle"
},
{
"code" : "CapabilityStatement"
},
{
"code" : "CarePlan",
"param" : ["subject"]
},
{
"code" : "CareTeam",
"param" : ["subject",
"participant"]
},
{
"code" : "ChargeItem",
"param" : ["subject"]
},
{
"code" : "ChargeItemDefinition"
},
{
"code" : "Citation"
},
{
"code" : "Claim"
},
{
"code" : "ClaimResponse"
},
{
"code" : "ClinicalAssessment",
"param" : ["subject"]
},
{
"code" : "ClinicalUseDefinition"
},
{
"code" : "CodeSystem"
},
{
"code" : "Communication",
"param" : ["subject"]
},
{
"code" : "CommunicationRequest",
"param" : ["subject"]
},
{
"code" : "CompartmentDefinition"
},
{
"code" : "Composition"
},
{
"code" : "ConceptMap"
},
{
"code" : "Condition",
"param" : ["subject"]
},
{
"code" : "ConditionDefinition"
},
{
"code" : "Consent",
"param" : ["subject",
"actor",
"grantee"]
},
{
"code" : "Contract"
},
{
"code" : "Coverage"
},
{
"code" : "CoverageEligibilityRequest"
},
{
"code" : "CoverageEligibilityResponse"
},
{
"code" : "DetectedIssue",
"param" : ["subject"]
},
{
"code" : "Device"
},
{
"code" : "DeviceAlert"
},
{
"code" : "DeviceAssociation",
"param" : ["subject"]
},
{
"code" : "DeviceDefinition"
},
{
"code" : "DeviceDispense",
"param" : ["subject"]
},
{
"code" : "DeviceMetric"
},
{
"code" : "DeviceRequest",
"param" : ["subject",
"requester"]
},
{
"code" : "DeviceUsage",
"param" : ["subject"]
},
{
"code" : "DiagnosticReport",
"param" : ["subject"]
},
{
"code" : "DocumentReference",
"param" : ["attester",
"author",
"subject"]
},
{
"code" : "Encounter",
"param" : ["subject",
"participant"]
},
{
"code" : "EncounterHistory",
"param" : ["subject"]
},
{
"code" : "Endpoint"
},
{
"code" : "EnrollmentRequest",
"param" : ["group"]
},
{
"code" : "EnrollmentResponse",
"param" : ["group"]
},
{
"code" : "EpisodeOfCare",
"param" : ["subject"]
},
{
"code" : "EventDefinition"
},
{
"code" : "Evidence"
},
{
"code" : "EvidenceVariable"
},
{
"code" : "ExampleScenario"
},
{
"code" : "ExplanationOfBenefit"
},
{
"code" : "FamilyMemberHistory"
},
{
"code" : "Flag",
"param" : ["subject"]
},
{
"code" : "FormularyItem"
},
{
"code" : "GenomicStudy",
"param" : ["subject"]
},
{
"code" : "Goal",
"param" : ["subject"]
},
{
"code" : "GraphDefinition"
},
{
"code" : "Group"
},
{
"code" : "GuidanceResponse",
"param" : ["subject"]
},
{
"code" : "HealthcareService"
},
{
"code" : "ImagingSelection",
"param" : ["subject"]
},
{
"code" : "ImagingStudy",
"param" : ["subject"]
},
{
"code" : "Immunization"
},
{
"code" : "ImmunizationEvaluation"
},
{
"code" : "ImmunizationRecommendation"
},
{
"code" : "ImplementationGuide"
},
{
"code" : "Ingredient"
},
{
"code" : "InsurancePlan"
},
{
"code" : "InsuranceProduct"
},
{
"code" : "InventoryItem",
"param" : ["subject"]
},
{
"code" : "InventoryReport"
},
{
"code" : "Invoice",
"param" : ["subject"]
},
{
"code" : "Library"
},
{
"code" : "Linkage"
},
{
"code" : "List"
},
{
"code" : "Location"
},
{
"code" : "ManufacturedItemDefinition"
},
{
"code" : "Measure"
},
{
"code" : "MeasureReport",
"param" : ["subject"]
},
{
"code" : "Medication"
},
{
"code" : "MedicationAdministration",
"param" : ["subject"]
},
{
"code" : "MedicationDispense",
"param" : ["subject"]
},
{
"code" : "MedicationKnowledge"
},
{
"code" : "MedicationRequest",
"param" : ["subject"]
},
{
"code" : "MedicationStatement",
"param" : ["subject"]
},
{
"code" : "MedicinalProductDefinition"
},
{
"code" : "MessageDefinition"
},
{
"code" : "MessageHeader"
},
{
"code" : "MolecularDefinition"
},
{
"code" : "NamingSystem"
},
{
"code" : "NutritionIntake",
"param" : ["subject"]
},
{
"code" : "NutritionOrder",
"param" : ["subject"]
},
{
"code" : "NutritionProduct"
},
{
"code" : "Observation",
"param" : ["specimen",
"subject",
"performer"]
},
{
"code" : "ObservationDefinition"
},
{
"code" : "OperationDefinition"
},
{
"code" : "OperationOutcome"
},
{
"code" : "Organization"
},
{
"code" : "OrganizationAffiliation"
},
{
"code" : "PackagedProductDefinition"
},
{
"code" : "Patient"
},
{
"code" : "PaymentNotice"
},
{
"code" : "PaymentReconciliation"
},
{
"code" : "Permission"
},
{
"code" : "Person"
},
{
"code" : "PersonalRelationship"
},
{
"code" : "PlanDefinition"
},
{
"code" : "Practitioner"
},
{
"code" : "PractitionerRole"
},
{
"code" : "Procedure",
"param" : ["subject"]
},
{
"code" : "Provenance",
"param" : ["agent"]
},
{
"code" : "Questionnaire"
},
{
"code" : "QuestionnaireResponse"
},
{
"code" : "RegulatedAuthorization"
},
{
"code" : "RelatedPerson"
},
{
"code" : "RequestOrchestration",
"param" : ["participant",
"subject"]
},
{
"code" : "Requirements"
},
{
"code" : "ResearchStudy",
"param" : ["eligibility"]
},
{
"code" : "ResearchSubject",
"param" : ["subject"]
},
{
"code" : "RiskAssessment",
"param" : ["subject"]
},
{
"code" : "Schedule"
},
{
"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" : "SupplyDelivery",
"param" : ["subject",
"receiver"]
},
{
"code" : "SupplyRequest"
},
{
"code" : "Task",
"param" : ["subject"]
},
{
"code" : "TerminologyCapabilities"
},
{
"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-ballot3 generated on Fri, Oct 24, 2025 06:07+0000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R5 |
|
Propose a change