CompartmentDefinition resource (FHIR R4)
CompartmentDefinition is the FHIR R4 resource for a compartment definition that defines how resources are accessed on a server.
| Resource | CompartmentDefinition |
|---|---|
| FHIR version | R4 (4.0.1) |
| Canonical URL | http://hl7.org/fhir/StructureDefinition/CompartmentDefinition |
| Required elements | url (1..1), name (1..1), status (1..1), code (1..1), search (1..1) |
Example
{
"resourceType": "CompartmentDefinition",
"id": "compartmentdefinition-ea652d6fca216835dbc8ea9e4b8a8268",
"url": "http://example.org/pidgeon/synthetic",
"name": "Synthetic value",
"status": "draft",
"code": "Patient",
"search": true
}Generated by the Pidgeon engine: pidgeon generate CompartmentDefinition --seed 20260722.
Validation context
- strict pidgeon validate grades a CompartmentDefinition instance against the base R4 structure definition: missing required elements raise REQUIRED_FIELD_MISSING and cardinality violations raise CARDINALITY_MIN or CARDINALITY_MAX.(REQUIRED_FIELD_MISSING)
This answer, in your terminal
pidgeon lookup CompartmentDefinitionWire it into your AI agent:
claude mcp add pidgeon -- npx -y @pidgeonhealth/mcpDownload Post free to browse this reference with generation attached.