CompartmentDefinition - FHIR Resource (r4)

This CompartmentDefinition Resource uses the FHIR API standard for access and structure.

Validate an CompartmentDefinition FHIR Resource (r4)

CompartmentDefinition Attributes

AttributeField is listTypeDescription

Description: Canonical identifier for this compartment definition, represented as a URI (globally unique)

FHIR Version: r4

Attribute Type : uri

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"url": "http://hl7.org/fhir/CompartmentDefinition/patient"

Learn more about the (CompartmentDefinition) url FHIR attribute

Description: Business version of the compartment definition

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"version": "4.0.1"

Learn more about the (CompartmentDefinition) version FHIR attribute

Description: C? Name for this compartment definition (computer friendly)

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"name": "Base FHIR compartment definition for Patient"

Learn more about the (CompartmentDefinition) name FHIR attribute

Description: draft | active | retired | unknown

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"status": "draft"

Learn more about the (CompartmentDefinition) status FHIR attribute

Description: For testing purposes, not real usage

FHIR Version: r4

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"experimental": true

Learn more about the (CompartmentDefinition) experimental FHIR attribute

Description: Date last changed

FHIR Version: r4

Attribute Type : dateTime

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"date": "2019-11-01T09:29:23+11:00"

Learn more about the (CompartmentDefinition) date FHIR attribute

Description: Name of the publisher (organization or individual)

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"publisher": "FHIR Project Team"

Learn more about the (CompartmentDefinition) publisher FHIR attribute

Description: Contact details for the publisher

FHIR Version: r4

Attribute Type : ContactDetail

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"contact": [
  {
    "telecom": [
      {
        "system": "url",
        "value": "http://hl7.org/fhir"
      }
    ]
  }
]

Learn more about the (CompartmentDefinition) contact FHIR attribute

Description: Natural language description of the compartment definition

FHIR Version: r4

Attribute Type : markdown

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"description": "There is an instance of the patient compartment for each patient resource, and the identity of the compartment is the same as the patient. When a patient is linked to another patient, all the records associated with the linked patient are in the compartment associated with the target of the link.. The set of resources associated with a particular patient"

Learn more about the (CompartmentDefinition) description FHIR attribute

Description: The context that the content is intended to support

FHIR Version: r4

Attribute Type : UsageContext

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"useContext":

Learn more about the (CompartmentDefinition) useContext FHIR attribute

Description: Why this compartment definition is defined

FHIR Version: r4

Attribute Type : markdown

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"purpose":

Learn more about the (CompartmentDefinition) purpose FHIR attribute

Description: Patient | Encounter | RelatedPerson | Practitioner | Device

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"code": "Patient"

Learn more about the (CompartmentDefinition) code FHIR attribute

Description: Whether the search syntax is supported

FHIR Version: r4

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"search": true

Learn more about the (CompartmentDefinition) search FHIR attribute

Description: How a resource is related to the compartment

FHIR Version: r4

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"resource": [
  {
    "code": "Account",
    "param": [
      "subject"
    ]
  },
  {
    "code": "ActivityDefinition"
  },
  {
    "code": "AdverseEvent",
    "param": [
      "subject"
    ]
  },
  {
    "code": "AllergyIntolerance",
    "param": [
      "patient",
      "recorder",
      "asserter"
    ]
  },
  {
    "code": "Appointment",
    "param": [
      "actor"
    ]
  },
  {
    "code": "AppointmentResponse",
    "param": [
      "actor"
    ]
  },
  {
    "code": "AuditEvent",
    "param": [
      "patient"
    ]
  },
  {
    "code": "Basic",
    "param": [
      "patient",
      "author"
    ]
  },
  {
    "code": "Binary"
  },
  {
    "code": "BiologicallyDerivedProduct"
  },
  {
    "code": "BodyStructure",
    "param": [
      "patient"
    ]
  },
  {
    "code": "Bundle"
  },
  {
    "code": "CapabilityStatement"
  },
  {
    "code": "CarePlan",
    "param": [
      "patient",
      "performer"
    ]
  },
  {
    "code": "CareTeam",
    "param": [
      "patient",
      "participant"
    ]
  },
  {
    "code": "CatalogEntry"
  },
  {
    "code": "ChargeItem",
    "param": [
      "subject"
    ]
  },
  {
    "code": "ChargeItemDefinition"
  },
  {
    "code": "Claim",
    "param": [
      "patient",
      "payee"
    ]
  },
  {
    "code": "ClaimResponse",
    "param": [
      "patient"
    ]
  },
  {
    "code": "ClinicalImpression",
    "param": [
      "subject"
    ]
  },
  {
    "code": "CodeSystem"
  },
  {
    "code": "Communication",
    "param": [
      "subject",
      "sender",
      "recipient"
    ]
  },
  {
    "code": "CommunicationRequest",
    "param": [
      "subject",
      "sender",
      "recipient",
      "requester"
    ]
  },
  {
    "code": "CompartmentDefinition"
  },
  {
    "code": "Composition",
    "param": [
      "subject",
      "author",
      "attester"
    ]
  },
  {
    "code": "ConceptMap"
  },
  {
    "code": "Condition",
    "param": [
      "patient",
      "asserter"
    ]
  },
  {
    "code": "Consent",
    "param": [
      "patient"
    ]
  },
  {
    "code": "Contract"
  },
  {
    "code": "Coverage",
    "param": [
      "policy-holder",
      "subscriber",
      "beneficiary",
      "payor"
    ]
  },
  {
    "code": "CoverageEligibilityRequest",
    "param": [
      "patient"
    ]
  },
  {
    "code": "CoverageEligibilityResponse",
    "param": [
      "patient"
    ]
  },
  {
    "code": "DetectedIssue",
    "param": [
      "patient"
    ]
  },
  {
    "code": "Device"
  },
  {
    "code": "DeviceDefinition"
  },
  {
    "code": "DeviceMetric"
  },
  {
    "code": "DeviceRequest",
    "param": [
      "subject",
      "performer"
    ]
  },
  {
    "code": "DeviceUseStatement",
    "param": [
      "subject"
    ]
  },
  {
    "code": "DiagnosticReport",
    "param": [
      "subject"
    ]
  },
  {
    "code": "DocumentManifest",
    "param": [
      "subject",
      "author",
      "recipient"
    ]
  },
  {
    "code": "DocumentReference",
    "param": [
      "subject",
      "author"
    ]
  },
  {
    "code": "EffectEvidenceSynthesis"
  },
  {
    "code": "Encounter",
    "param": [
      "patient"
    ]
  },
  {
    "code": "Endpoint"
  },
  {
    "code": "EnrollmentRequest",
    "param": [
      "subject"
    ]
  },
  {
    "code": "EnrollmentResponse"
  },
  {
    "code": "EpisodeOfCare",
    "param": [
      "patient"
    ]
  },
  {
    "code": "EventDefinition"
  },
  {
    "code": "Evidence"
  },
  {
    "code": "EvidenceVariable"
  },
  {
    "code": "ExampleScenario"
  },
  {
    "code": "ExplanationOfBenefit",
    "param": [
      "patient",
      "payee"
    ]
  },
  {
    "code": "FamilyMemberHistory",
    "param": [
      "patient"
    ]
  },
  {
    "code": "Flag",
    "param": [
      "patient"
    ]
  },
  {
    "code": "Goal",
    "param": [
      "patient"
    ]
  },
  {
    "code": "GraphDefinition"
  },
  {
    "code": "Group",
    "param": [
      "member"
    ]
  },
  {
    "code": "GuidanceResponse"
  },
  {
    "code": "HealthcareService"
  },
  {
    "code": "ImagingStudy",
    "param": [
      "patient"
    ]
  },
  {
    "code": "Immunization",
    "param": [
      "patient"
    ]
  },
  {
    "code": "ImmunizationEvaluation",
    "param": [
      "patient"
    ]
  },
  {
    "code": "ImmunizationRecommendation",
    "param": [
      "patient"
    ]
  },
  {
    "code": "ImplementationGuide"
  },
  {
    "code": "InsurancePlan"
  },
  {
    "code": "Invoice",
    "param": [
      "subject",
      "patient",
      "recipient"
    ]
  },
  {
    "code": "Library"
  },
  {
    "code": "Linkage"
  },
  {
    "code": "List",
    "param": [
      "subject",
      "source"
    ]
  },
  {
    "code": "Location"
  },
  {
    "code": "Measure"
  },
  {
    "code": "MeasureReport",
    "param": [
      "patient"
    ]
  },
  {
    "code": "Media",
    "param": [
      "subject"
    ]
  },
  {
    "code": "Medication"
  },
  {
    "code": "MedicationAdministration",
    "param": [
      "patient",
      "performer",
      "subject"
    ]
  },
  {
    "code": "MedicationDispense",
    "param": [
      "subject",
      "patient",
      "receiver"
    ]
  },
  {
    "code": "MedicationKnowledge"
  },
  {
    "code": "MedicationRequest",
    "param": [
      "subject"
    ]
  },
  {
    "code": "MedicationStatement",
    "param": [
      "subject"
    ]
  },
  {
    "code": "MedicinalProduct"
  },
  {
    "code": "MedicinalProductAuthorization"
  },
  {
    "code": "MedicinalProductContraindication"
  },
  {
    "code": "MedicinalProductIndication"
  },
  {
    "code": "MedicinalProductIngredient"
  },
  {
    "code": "MedicinalProductInteraction"
  },
  {
    "code": "MedicinalProductManufactured"
  },
  {
    "code": "MedicinalProductPackaged"
  },
  {
    "code": "MedicinalProductPharmaceutical"
  },
  {
    "code": "MedicinalProductUndesirableEffect"
  },
  {
    "code": "MessageDefinition"
  },
  {
    "code": "MessageHeader"
  },
  {
    "code": "MolecularSequence",
    "param": [
      "patient"
    ]
  },
  {
    "code": "NamingSystem"
  },
  {
    "code": "NutritionOrder",
    "param": [
      "patient"
    ]
  },
  {
    "code": "Observation",
    "param": [
      "subject",
      "performer"
    ]
  },
  {
    "code": "ObservationDefinition"
  },
  {
    "code": "OperationDefinition"
  },
  {
    "code": "OperationOutcome"
  },
  {
    "code": "Organization"
  },
  {
    "code": "OrganizationAffiliation"
  },
  {
    "code": "Patient",
    "param": [
      "link"
    ]
  },
  {
    "code": "PaymentNotice"
  },
  {
    "code": "PaymentReconciliation"
  },
  {
    "code": "Person",
    "param": [
      "patient"
    ]
  },
  {
    "code": "PlanDefinition"
  },
  {
    "code": "Practitioner"
  },
  {
    "code": "PractitionerRole"
  },
  {
    "code": "Procedure",
    "param": [
      "patient",
      "performer"
    ]
  },
  {
    "code": "Provenance",
    "param": [
      "patient"
    ]
  },
  {
    "code": "Questionnaire"
  },
  {
    "code": "QuestionnaireResponse",
    "param": [
      "subject",
      "author"
    ]
  },
  {
    "code": "RelatedPerson",
    "param": [
      "patient"
    ]
  },
  {
    "code": "RequestGroup",
    "param": [
      "subject",
      "participant"
    ]
  },
  {
    "code": "ResearchDefinition"
  },
  {
    "code": "ResearchElementDefinition"
  },
  {
    "code": "ResearchStudy"
  },
  {
    "code": "ResearchSubject",
    "param": [
      "individual"
    ]
  },
  {
    "code": "RiskAssessment",
    "param": [
      "subject"
    ]
  },
  {
    "code": "RiskEvidenceSynthesis"
  },
  {
    "code": "Schedule",
    "param": [
      "actor"
    ]
  },
  {
    "code": "SearchParameter"
  },
  {
    "code": "ServiceRequest",
    "param": [
      "subject",
      "performer"
    ]
  },
  {
    "code": "Slot"
  },
  {
    "code": "Specimen",
    "param": [
      "subject"
    ]
  },
  {
    "code": "SpecimenDefinition"
  },
  {
    "code": "StructureDefinition"
  },
  {
    "code": "StructureMap"
  },
  {
    "code": "Subscription"
  },
  {
    "code": "Substance"
  },
  {
    "code": "SubstanceNucleicAcid"
  },
  {
    "code": "SubstancePolymer"
  },
  {
    "code": "SubstanceProtein"
  },
  {
    "code": "SubstanceReferenceInformation"
  },
  {
    "code": "SubstanceSourceMaterial"
  },
  {
    "code": "SubstanceSpecification"
  },
  {
    "code": "SupplyDelivery",
    "param": [
      "patient"
    ]
  },
  {
    "code": "SupplyRequest",
    "param": [
      "subject"
    ]
  },
  {
    "code": "Task"
  },
  {
    "code": "TerminologyCapabilities"
  },
  {
    "code": "TestReport"
  },
  {
    "code": "TestScript"
  },
  {
    "code": "ValueSet"
  },
  {
    "code": "VerificationResult"
  },
  {
    "code": "VisionPrescription",
    "param": [
      "patient"
    ]
  }
]

Learn more about the (CompartmentDefinition) resource FHIR attribute

CompartmentDefinition Example

{
  "resourceType": "CompartmentDefinition",
  "id": "patient",
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "url": "http://hl7.org/fhir/CompartmentDefinition/patient",
  "version": "4.0.1",
  "name": "Base FHIR compartment definition for Patient",
  "status": "draft",
  "experimental": true,
  "date": "2019-11-01T09:29:23+11:00",
  "publisher": "FHIR Project Team",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        }
      ]
    }
  ],
  "description": "There is an instance of the patient compartment for each patient resource, and the identity of the compartment is the same as the patient. When a patient is linked to another patient, all the records associated with the linked patient are in the compartment associated with the target of the link.. The set of resources associated with a particular patient",
  "code": "Patient",
  "search": true,
  "resource": [
    {
      "code": "Account",
      "param": [
        "subject"
      ]
    },
    {
      "code": "ActivityDefinition"
    },
    {
      "code": "AdverseEvent",
      "param": [
        "subject"
      ]
    },
    {
      "code": "AllergyIntolerance",
      "param": [
        "patient",
        "recorder",
        "asserter"
      ]
    },
    {
      "code": "Appointment",
      "param": [
        "actor"
      ]
    },
    {
      "code": "AppointmentResponse",
      "param": [
        "actor"
      ]
    },
    {
      "code": "AuditEvent",
      "param": [
        "patient"
      ]
    },
    {
      "code": "Basic",
      "param": [
        "patient",
        "author"
      ]
    },
    {
      "code": "Binary"
    },
    {
      "code": "BiologicallyDerivedProduct"
    },
    {
      "code": "BodyStructure",
      "param": [
        "patient"
      ]
    },
    {
      "code": "Bundle"
    },
    {
      "code": "CapabilityStatement"
    },
    {
      "code": "CarePlan",
      "param": [
        "patient",
        "performer"
      ]
    },
    {
      "code": "CareTeam",
      "param": [
        "patient",
        "participant"
      ]
    },
    {
      "code": "CatalogEntry"
    },
    {
      "code": "ChargeItem",
      "param": [
        "subject"
      ]
    },
    {
      "code": "ChargeItemDefinition"
    },
    {
      "code": "Claim",
      "param": [
        "patient",
        "payee"
      ]
    },
    {
      "code": "ClaimResponse",
      "param": [
        "patient"
      ]
    },
    {
      "code": "ClinicalImpression",
      "param": [
        "subject"
      ]
    },
    {
      "code": "CodeSystem"
    },
    {
      "code": "Communication",
      "param": [
        "subject",
        "sender",
        "recipient"
      ]
    },
    {
      "code": "CommunicationRequest",
      "param": [
        "subject",
        "sender",
        "recipient",
        "requester"
      ]
    },
    {
      "code": "CompartmentDefinition"
    },
    {
      "code": "Composition",
      "param": [
        "subject",
        "author",
        "attester"
      ]
    },
    {
      "code": "ConceptMap"
    },
    {
      "code": "Condition",
      "param": [
        "patient",
        "asserter"
      ]
    },
    {
      "code": "Consent",
      "param": [
        "patient"
      ]
    },
    {
      "code": "Contract"
    },
    {
      "code": "Coverage",
      "param": [
        "policy-holder",
        "subscriber",
        "beneficiary",
        "payor"
      ]
    },
    {
      "code": "CoverageEligibilityRequest",
      "param": [
        "patient"
      ]
    },
    {
      "code": "CoverageEligibilityResponse",
      "param": [
        "patient"
      ]
    },
    {
      "code": "DetectedIssue",
      "param": [
        "patient"
      ]
    },
    {
      "code": "Device"
    },
    {
      "code": "DeviceDefinition"
    },
    {
      "code": "DeviceMetric"
    },
    {
      "code": "DeviceRequest",
      "param": [
        "subject",
        "performer"
      ]
    },
    {
      "code": "DeviceUseStatement",
      "param": [
        "subject"
      ]
    },
    {
      "code": "DiagnosticReport",
      "param": [
        "subject"
      ]
    },
    {
      "code": "DocumentManifest",
      "param": [
        "subject",
        "author",
        "recipient"
      ]
    },
    {
      "code": "DocumentReference",
      "param": [
        "subject",
        "author"
      ]
    },
    {
      "code": "EffectEvidenceSynthesis"
    },
    {
      "code": "Encounter",
      "param": [
        "patient"
      ]
    },
    {
      "code": "Endpoint"
    },
    {
      "code": "EnrollmentRequest",
      "param": [
        "subject"
      ]
    },
    {
      "code": "EnrollmentResponse"
    },
    {
      "code": "EpisodeOfCare",
      "param": [
        "patient"
      ]
    },
    {
      "code": "EventDefinition"
    },
    {
      "code": "Evidence"
    },
    {
      "code": "EvidenceVariable"
    },
    {
      "code": "ExampleScenario"
    },
    {
      "code": "ExplanationOfBenefit",
      "param": [
        "patient",
        "payee"
      ]
    },
    {
      "code": "FamilyMemberHistory",
      "param": [
        "patient"
      ]
    },
    {
      "code": "Flag",
      "param": [
        "patient"
      ]
    },
    {
      "code": "Goal",
      "param": [
        "patient"
      ]
    },
    {
      "code": "GraphDefinition"
    },
    {
      "code": "Group",
      "param": [
        "member"
      ]
    },
    {
      "code": "GuidanceResponse"
    },
    {
      "code": "HealthcareService"
    },
    {
      "code": "ImagingStudy",
      "param": [
        "patient"
      ]
    },
    {
      "code": "Immunization",
      "param": [
        "patient"
      ]
    },
    {
      "code": "ImmunizationEvaluation",
      "param": [
        "patient"
      ]
    },
    {
      "code": "ImmunizationRecommendation",
      "param": [
        "patient"
      ]
    },
    {
      "code": "ImplementationGuide"
    },
    {
      "code": "InsurancePlan"
    },
    {
      "code": "Invoice",
      "param": [
        "subject",
        "patient",
        "recipient"
      ]
    },
    {
      "code": "Library"
    },
    {
      "code": "Linkage"
    },
    {
      "code": "List",
      "param": [
        "subject",
        "source"
      ]
    },
    {
      "code": "Location"
    },
    {
      "code": "Measure"
    },
    {
      "code": "MeasureReport",
      "param": [
        "patient"
      ]
    },
    {
      "code": "Media",
      "param": [
        "subject"
      ]
    },
    {
      "code": "Medication"
    },
    {
      "code": "MedicationAdministration",
      "param": [
        "patient",
        "performer",
        "subject"
      ]
    },
    {
      "code": "MedicationDispense",
      "param": [
        "subject",
        "patient",
        "receiver"
      ]
    },
    {
      "code": "MedicationKnowledge"
    },
    {
      "code": "MedicationRequest",
      "param": [
        "subject"
      ]
    },
    {
      "code": "MedicationStatement",
      "param": [
        "subject"
      ]
    },
    {
      "code": "MedicinalProduct"
    },
    {
      "code": "MedicinalProductAuthorization"
    },
    {
      "code": "MedicinalProductContraindication"
    },
    {
      "code": "MedicinalProductIndication"
    },
    {
      "code": "MedicinalProductIngredient"
    },
    {
      "code": "MedicinalProductInteraction"
    },
    {
      "code": "MedicinalProductManufactured"
    },
    {
      "code": "MedicinalProductPackaged"
    },
    {
      "code": "MedicinalProductPharmaceutical"
    },
    {
      "code": "MedicinalProductUndesirableEffect"
    },
    {
      "code": "MessageDefinition"
    },
    {
      "code": "MessageHeader"
    },
    {
      "code": "MolecularSequence",
      "param": [
        "patient"
      ]
    },
    {
      "code": "NamingSystem"
    },
    {
      "code": "NutritionOrder",
      "param": [
        "patient"
      ]
    },
    {
      "code": "Observation",
      "param": [
        "subject",
        "performer"
      ]
    },
    {
      "code": "ObservationDefinition"
    },
    {
      "code": "OperationDefinition"
    },
    {
      "code": "OperationOutcome"
    },
    {
      "code": "Organization"
    },
    {
      "code": "OrganizationAffiliation"
    },
    {
      "code": "Patient",
      "param": [
        "link"
      ]
    },
    {
      "code": "PaymentNotice"
    },
    {
      "code": "PaymentReconciliation"
    },
    {
      "code": "Person",
      "param": [
        "patient"
      ]
    },
    {
      "code": "PlanDefinition"
    },
    {
      "code": "Practitioner"
    },
    {
      "code": "PractitionerRole"
    },
    {
      "code": "Procedure",
      "param": [
        "patient",
        "performer"
      ]
    },
    {
      "code": "Provenance",
      "param": [
        "patient"
      ]
    },
    {
      "code": "Questionnaire"
    },
    {
      "code": "QuestionnaireResponse",
      "param": [
        "subject",
        "author"
      ]
    },
    {
      "code": "RelatedPerson",
      "param": [
        "patient"
      ]
    },
    {
      "code": "RequestGroup",
      "param": [
        "subject",
        "participant"
      ]
    },
    {
      "code": "ResearchDefinition"
    },
    {
      "code": "ResearchElementDefinition"
    },
    {
      "code": "ResearchStudy"
    },
    {
      "code": "ResearchSubject",
      "param": [
        "individual"
      ]
    },
    {
      "code": "RiskAssessment",
      "param": [
        "subject"
      ]
    },
    {
      "code": "RiskEvidenceSynthesis"
    },
    {
      "code": "Schedule",
      "param": [
        "actor"
      ]
    },
    {
      "code": "SearchParameter"
    },
    {
      "code": "ServiceRequest",
      "param": [
        "subject",
        "performer"
      ]
    },
    {
      "code": "Slot"
    },
    {
      "code": "Specimen",
      "param": [
        "subject"
      ]
    },
    {
      "code": "SpecimenDefinition"
    },
    {
      "code": "StructureDefinition"
    },
    {
      "code": "StructureMap"
    },
    {
      "code": "Subscription"
    },
    {
      "code": "Substance"
    },
    {
      "code": "SubstanceNucleicAcid"
    },
    {
      "code": "SubstancePolymer"
    },
    {
      "code": "SubstanceProtein"
    },
    {
      "code": "SubstanceReferenceInformation"
    },
    {
      "code": "SubstanceSourceMaterial"
    },
    {
      "code": "SubstanceSpecification"
    },
    {
      "code": "SupplyDelivery",
      "param": [
        "patient"
      ]
    },
    {
      "code": "SupplyRequest",
      "param": [
        "subject"
      ]
    },
    {
      "code": "Task"
    },
    {
      "code": "TerminologyCapabilities"
    },
    {
      "code": "TestReport"
    },
    {
      "code": "TestScript"
    },
    {
      "code": "ValueSet"
    },
    {
      "code": "VerificationResult"
    },
    {
      "code": "VisionPrescription",
      "param": [
        "patient"
      ]
    }
  ]
}

CompartmentDefinition Structure

{
  "resourceType" : "CompartmentDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // R!  Canonical identifier for this compartment definition, represented as a URI (globally unique)
  "version" : "<string>", // Business version of the compartment definition
  "name" : "<string>", // C? R!  Name for this compartment definition (computer friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the compartment definition
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "purpose" : "<markdown>", // Why this compartment definition is defined
  "code" : "<code>", // R!  Patient | Encounter | RelatedPerson | Practitioner | Device
  "search" : <boolean>, // R!  Whether the search syntax is supported
  "resource" : [{ // How a resource is related to the compartment
    "code" : "<code>", // R!  Name of resource type
    "param" : ["<string>"], // Search Parameter Name, or chained parameters
    "documentation" : "<string>" // Additional documentation about the resource and compartment
  }]
}

CompartmentDefinition Search Parameters

The following search parameters can be used to query CompartmentDefinition resources. Just submit them like so:

https://api.1up.health/fhir/r4/CompartmentDefinition?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched
`code`	`text`	`code`
`context`	`text`	`useContext.value`
`context-quantity`	`quantity`	`useContext.value`
`context-type`	`text`	`useContext.code`
`context-type-quantity`	`composite`	`useContext`
`context-type-value`	`composite`	`useContext`
`date`	`date`	`date`
`description`	`text`	`description`
`name`	`text`	`name`
`publisher`	`text`	`publisher`
`resource`	`text`	`resource.code`
`status`	`text`	`status`
`url`	`uri`	`url`
`version`	`text`	`version`