FHIR CI-Build

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

Example CompartmentDefinition/group (JSON)

Responsible Owner: FHIR Infrastructure Work GroupStandards 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=\"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=\"claim.html\">CLAIM</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"claimresponse.html\">CLAIMRESPONSE</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=\"devicealert.html\">DEVICEALERT</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"deviceassociation.html\">DEVICEASSOCIATION</a></td><td>subject, focus</td></tr>\r\n <tr><td><a href=\"devicerequest.html\">DEVICEREQUEST</a></td><td>subject, requester</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=\"episodeofcare.html\">EPISODEOFCARE</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"explanationofbenefit.html\">EXPLANATIONOFBENEFIT</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=\"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=\"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=\"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=\"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=\"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=\"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=\"familymemberhistory.html\">FAMILYMEMBERHISTORY</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=\"implementationguide.html\">IMPLEMENTATIONGUIDE</a></li>\r\n <li><a href=\"ingredient.html\">INGREDIENT</a></li>\r\n <li><a href=\"library.html\">LIBRARY</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=\"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=\"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=\"person.html\">PERSON</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=\"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=\"terminologycapabilities.html\">TERMINOLOGYCAPABILITIES</a></li>\r\n <li><a href=\"valueset.html\">VALUESET</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-snapshot1",
  "name" : "Base FHIR compartment definition for Group",
  "status" : "draft",
  "experimental" : false,
  "date" : "2026-09-23T20:09:18+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",
    "startParam" : "period",
    "endParam" : "period"
  },
  {
    "code" : "ActivityDefinition"
  },
  {
    "code" : "ActorDefinition"
  },
  {
    "code" : "AdministrableProductDefinition"
  },
  {
    "code" : "AdverseEvent",
    "param" : ["subject"],
    "startParam" : "occurrence",
    "endParam" : "occurrence"
  },
  {
    "code" : "AllergyIntolerance",
    "startParam" : "date",
    "endParam" : "date"
  },
  {
    "code" : "Appointment",
    "param" : ["subject",
    "actor"],
    "startParam" : "date",
    "endParam" : "date"
  },
  {
    "code" : "AppointmentResponse",
    "param" : ["actor"]
  },
  {
    "code" : "ArtifactAssessment",
    "startParam" : "date",
    "endParam" : "date"
  },
  {
    "code" : "AuditEvent",
    "param" : ["agent"],
    "startParam" : "date",
    "endParam" : "date"
  },
  {
    "code" : "Basic",
    "startParam" : "created",
    "endParam" : "created"
  },
  {
    "code" : "Binary"
  },
  {
    "code" : "BiologicallyDerivedProduct"
  },
  {
    "code" : "BodyStructure"
  },
  {
    "code" : "Bundle"
  },
  {
    "code" : "CapabilityStatement"
  },
  {
    "code" : "CarePlan",
    "param" : ["subject"],
    "startParam" : "date",
    "endParam" : "date"
  },
  {
    "code" : "CareTeam",
    "param" : ["subject",
    "participant"],
    "startParam" : "date",
    "endParam" : "date"
  },
  {
    "code" : "Claim",
    "param" : ["subject"],
    "startParam" : "created",
    "endParam" : "created"
  },
  {
    "code" : "ClaimResponse",
    "param" : ["subject"],
    "startParam" : "created",
    "endParam" : "created"
  },
  {
    "code" : "ClinicalUseDefinition"
  },
  {
    "code" : "CodeSystem"
  },
  {
    "code" : "Communication",
    "param" : ["subject"],
    "startParam" : "sent",
    "endParam" : "sent"
  },
  {
    "code" : "CommunicationRequest",
    "param" : ["subject"],
    "startParam" : "authored",
    "endParam" : "authored"
  },
  {
    "code" : "CompartmentDefinition"
  },
  {
    "code" : "Composition",
    "startParam" : "date",
    "endParam" : "date"
  },
  {
    "code" : "ConceptMap"
  },
  {
    "code" : "Condition",
    "param" : ["subject"]
  },
  {
    "code" : "Consent",
    "param" : ["subject",
    "actor",
    "grantee"],
    "startParam" : "period",
    "endParam" : "period"
  },
  {
    "code" : "Coverage",
    "startParam" : "period",
    "endParam" : "period"
  },
  {
    "code" : "CoverageEligibilityRequest",
    "startParam" : "created",
    "endParam" : "created"
  },
  {
    "code" : "CoverageEligibilityResponse",
    "startParam" : "created",
    "endParam" : "created"
  },
  {
    "code" : "DetectedIssue",
    "param" : ["subject"],
    "startParam" : "identified",
    "endParam" : "identified"
  },
  {
    "code" : "Device"
  },
  {
    "code" : "DeviceAlert",
    "param" : ["subject"],
    "startParam" : "occurrence",
    "endParam" : "occurrence"
  },
  {
    "code" : "DeviceAssociation",
    "param" : ["subject",
    "focus"],
    "startParam" : "date",
    "endParam" : "date"
  },
  {
    "code" : "DeviceDefinition"
  },
  {
    "code" : "DeviceMetric"
  },
  {
    "code" : "DeviceRequest",
    "param" : ["subject",
    "requester"],
    "startParam" : "event-date",
    "endParam" : "event-date"
  },
  {
    "code" : "DiagnosticReport",
    "param" : ["subject"],
    "startParam" : "date",
    "endParam" : "date"
  },
  {
    "code" : "DocumentReference",
    "param" : ["attester",
    "author",
    "subject"],
    "startParam" : "date",
    "endParam" : "date"
  },
  {
    "code" : "Encounter",
    "param" : ["subject",
    "participant"],
    "startParam" : "date-start",
    "endParam" : "date-start"
  },
  {
    "code" : "Endpoint"
  },
  {
    "code" : "EpisodeOfCare",
    "param" : ["subject"],
    "startParam" : "date",
    "endParam" : "date"
  },
  {
    "code" : "EventDefinition"
  },
  {
    "code" : "Evidence"
  },
  {
    "code" : "EvidenceVariable"
  },
  {
    "code" : "ExampleScenario"
  },
  {
    "code" : "ExplanationOfBenefit",
    "param" : ["subject"],
    "startParam" : "created",
    "endParam" : "created"
  },
  {
    "code" : "FamilyMemberHistory",
    "startParam" : "date",
    "endParam" : "date"
  },
  {
    "code" : "Flag",
    "param" : ["subject"],
    "startParam" : "date",
    "endParam" : "date"
  },
  {
    "code" : "Goal",
    "param" : ["subject"],
    "startParam" : "start-date",
    "endParam" : "start-date"
  },
  {
    "code" : "Group"
  },
  {
    "code" : "GuidanceResponse",
    "param" : ["subject"]
  },
  {
    "code" : "HealthcareService"
  },
  {
    "code" : "ImagingSelection",
    "param" : ["subject"],
    "startParam" : "issued",
    "endParam" : "issued"
  },
  {
    "code" : "ImagingStudy",
    "param" : ["subject"],
    "startParam" : "started",
    "endParam" : "started"
  },
  {
    "code" : "Immunization",
    "startParam" : "date",
    "endParam" : "date"
  },
  {
    "code" : "ImplementationGuide"
  },
  {
    "code" : "Ingredient"
  },
  {
    "code" : "Library"
  },
  {
    "code" : "List",
    "startParam" : "date",
    "endParam" : "date"
  },
  {
    "code" : "Location"
  },
  {
    "code" : "ManufacturedItemDefinition"
  },
  {
    "code" : "Measure"
  },
  {
    "code" : "MeasureReport",
    "param" : ["subject"],
    "startParam" : "date",
    "endParam" : "date"
  },
  {
    "code" : "Medication"
  },
  {
    "code" : "MedicationAdministration",
    "param" : ["subject"],
    "startParam" : "date",
    "endParam" : "date"
  },
  {
    "code" : "MedicationDispense",
    "param" : ["subject"],
    "startParam" : "whenhandedover",
    "endParam" : "whenhandedover"
  },
  {
    "code" : "MedicationRequest",
    "param" : ["subject"],
    "startParam" : "combo-date",
    "endParam" : "combo-date"
  },
  {
    "code" : "MedicationStatement",
    "param" : ["subject"],
    "startParam" : "effective",
    "endParam" : "effective"
  },
  {
    "code" : "MedicinalProductDefinition"
  },
  {
    "code" : "MessageDefinition"
  },
  {
    "code" : "MessageHeader"
  },
  {
    "code" : "NamingSystem"
  },
  {
    "code" : "NutritionIntake",
    "param" : ["subject"],
    "startParam" : "date",
    "endParam" : "date"
  },
  {
    "code" : "NutritionOrder",
    "param" : ["subject"],
    "startParam" : "datetime",
    "endParam" : "datetime"
  },
  {
    "code" : "NutritionProduct"
  },
  {
    "code" : "Observation",
    "param" : ["specimen",
    "subject",
    "performer"],
    "startParam" : "date",
    "endParam" : "date"
  },
  {
    "code" : "ObservationDefinition"
  },
  {
    "code" : "OperationDefinition"
  },
  {
    "code" : "OperationOutcome"
  },
  {
    "code" : "Organization"
  },
  {
    "code" : "OrganizationAffiliation",
    "startParam" : "date",
    "endParam" : "date"
  },
  {
    "code" : "PackagedProductDefinition"
  },
  {
    "code" : "Patient"
  },
  {
    "code" : "PaymentNotice",
    "startParam" : "created",
    "endParam" : "created"
  },
  {
    "code" : "PaymentReconciliation",
    "startParam" : "created",
    "endParam" : "created"
  },
  {
    "code" : "Person"
  },
  {
    "code" : "PlanDefinition"
  },
  {
    "code" : "Practitioner"
  },
  {
    "code" : "PractitionerRole",
    "startParam" : "date",
    "endParam" : "date"
  },
  {
    "code" : "Procedure",
    "param" : ["subject"],
    "startParam" : "date",
    "endParam" : "date"
  },
  {
    "code" : "Provenance",
    "param" : ["agent"],
    "startParam" : "when",
    "endParam" : "when"
  },
  {
    "code" : "Questionnaire"
  },
  {
    "code" : "QuestionnaireResponse",
    "startParam" : "answer-date",
    "endParam" : "answer-date"
  },
  {
    "code" : "RegulatedAuthorization"
  },
  {
    "code" : "RelatedPerson"
  },
  {
    "code" : "RequestOrchestration",
    "param" : ["participant",
    "subject"]
  },
  {
    "code" : "Requirements"
  },
  {
    "code" : "ResearchStudy",
    "param" : ["eligibility"],
    "startParam" : "date",
    "endParam" : "date"
  },
  {
    "code" : "ResearchSubject",
    "param" : ["subject"],
    "startParam" : "date",
    "endParam" : "date"
  },
  {
    "code" : "RiskAssessment",
    "param" : ["subject"],
    "startParam" : "date",
    "endParam" : "date"
  },
  {
    "code" : "Schedule",
    "startParam" : "date",
    "endParam" : "date"
  },
  {
    "code" : "SearchParameter"
  },
  {
    "code" : "ServiceRequest",
    "param" : ["subject",
    "performer"],
    "startParam" : "occurrence",
    "endParam" : "occurrence"
  },
  {
    "code" : "Slot"
  },
  {
    "code" : "Specimen",
    "param" : ["subject"],
    "startParam" : "collected",
    "endParam" : "collected"
  },
  {
    "code" : "SpecimenDefinition"
  },
  {
    "code" : "StructureDefinition"
  },
  {
    "code" : "Subscription"
  },
  {
    "code" : "SubscriptionStatus"
  },
  {
    "code" : "SubscriptionTopic"
  },
  {
    "code" : "Substance"
  },
  {
    "code" : "SubstanceDefinition"
  },
  {
    "code" : "Task",
    "param" : ["subject"],
    "startParam" : "period",
    "endParam" : "period"
  },
  {
    "code" : "TerminologyCapabilities"
  },
  {
    "code" : "ValueSet"
  },
  {
    "code" : "VisionPrescription",
    "startParam" : "datewritten",
    "endParam" : "datewritten"
  }]
}

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.