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/device (JSON)

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: Informative

Raw JSON (canonical form + also see JSON Format Specification)

Compartment Definition for device

{
  "resourceType" : "CompartmentDefinition",
  "id" : "device",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><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=\"account.html\">Account</a></td><td>subject</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=\"auditevent.html\">AuditEvent</a></td><td>agent</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>procedure-udi, item-udi, detail-udi, subdetail-udi</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</td></tr>\r\n <tr><td><a href=\"composition.html\">Composition</a></td><td>author</td></tr>\r\n <tr><td><a href=\"detectedissue.html\">DetectedIssue</a></td><td>author</td></tr>\r\n <tr><td><a href=\"devicerequest.html\">DeviceRequest</a></td><td>subject, requester, performer</td></tr>\r\n <tr><td><a href=\"diagnosticreport.html\">DiagnosticReport</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"documentmanifest.html\">DocumentManifest</a></td><td>subject, author</td></tr>\r\n <tr><td><a href=\"documentreference.html\">DocumentReference</a></td><td>subject, author</td></tr>\r\n <tr><td><a href=\"explanationofbenefit.html\">ExplanationOfBenefit</a></td><td>procedure-udi, item-udi, detail-udi, subdetail-udi</td></tr>\r\n <tr><td><a href=\"flag.html\">Flag</a></td><td>author</td></tr>\r\n <tr><td><a href=\"group.html\">Group</a></td><td>member</td></tr>\r\n <tr><td><a href=\"invoice.html\">Invoice</a></td><td>participant</td></tr>\r\n <tr><td><a href=\"list.html\">List</a></td><td>subject, source</td></tr>\r\n <tr><td><a href=\"medicationadministration.html\">MedicationAdministration</a></td><td>device</td></tr>\r\n <tr><td><a href=\"messageheader.html\">MessageHeader</a></td><td>target</td></tr>\r\n <tr><td><a href=\"observation.html\">Observation</a></td><td>subject, device</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</td></tr>\r\n <tr><td><a href=\"requestorchestration.html\">RequestOrchestration</a></td><td>author</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>performer</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, requester</td></tr>\r\n <tr><td><a href=\"specimen.html\">Specimen</a></td><td>subject</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=\"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=\"adverseevent.html\">AdverseEvent</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=\"careplan.html\">CarePlan</a></li>\r\n <li><a href=\"careteam.html\">CareTeam</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=\"condition.html\">Condition</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=\"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=\"devicedispense.html\">DeviceDispense</a></li>\r\n <li><a href=\"devicemetric.html\">DeviceMetric</a></li>\r\n <li><a href=\"deviceusage.html\">DeviceUsage</a></li>\r\n <li><a href=\"encounter.html\">Encounter</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=\"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=\"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=\"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=\"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=\"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=\"medicationusage.html\">MedicationUsage</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=\"molecularsequence.html\">MolecularSequence</a></li>\r\n <li><a href=\"namingsystem.html\">NamingSystem</a></li>\r\n <li><a href=\"nutritionintake.html\">NutritionIntake</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=\"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=\"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=\"procedure.html\">Procedure</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=\"relatedperson.html\">RelatedPerson</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=\"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=\"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=\"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>"
  },
  "url" : "http://hl7.org/fhir/CompartmentDefinition/device",
  "version" : "5.0.0-cibuild",
  "name" : "Base FHIR compartment definition for Device",
  "status" : "draft",
  "experimental" : true,
  "date" : "2022-12-08T23:30:43+00:00",
  "publisher" : "FHIR Project Team",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    }]
  }],
  "description" : "There is an instance of the device compartment for each Device resource, and the identity of the compartment is the same as the Device. The set of resources associated with a particular device",
  "code" : "Device",
  "search" : true,
  "resource" : [{
    "code" : "Account",
    "param" : ["subject"]
  },
  {
    "code" : "ActivityDefinition"
  },
  {
    "code" : "ActorDefinition"
  },
  {
    "code" : "AdministrableProductDefinition"
  },
  {
    "code" : "AdverseEvent"
  },
  {
    "code" : "AllergyIntolerance"
  },
  {
    "code" : "Appointment",
    "param" : ["actor"]
  },
  {
    "code" : "AppointmentResponse",
    "param" : ["actor"]
  },
  {
    "code" : "ArtifactAssessment"
  },
  {
    "code" : "AuditEvent",
    "param" : ["agent"]
  },
  {
    "code" : "Basic"
  },
  {
    "code" : "Binary"
  },
  {
    "code" : "BiologicallyDerivedProduct"
  },
  {
    "code" : "BodyStructure"
  },
  {
    "code" : "Bundle"
  },
  {
    "code" : "CapabilityStatement"
  },
  {
    "code" : "CarePlan"
  },
  {
    "code" : "CareTeam"
  },
  {
    "code" : "ChargeItem",
    "param" : ["enterer",
    "performer-actor"]
  },
  {
    "code" : "ChargeItemDefinition"
  },
  {
    "code" : "Citation"
  },
  {
    "code" : "Claim",
    "param" : ["procedure-udi",
    "item-udi",
    "detail-udi",
    "subdetail-udi"]
  },
  {
    "code" : "ClaimResponse"
  },
  {
    "code" : "ClinicalImpression"
  },
  {
    "code" : "ClinicalUseDefinition"
  },
  {
    "code" : "CodeSystem"
  },
  {
    "code" : "Communication",
    "param" : ["sender",
    "recipient"]
  },
  {
    "code" : "CommunicationRequest",
    "param" : ["information-provider",
    "recipient"]
  },
  {
    "code" : "CompartmentDefinition"
  },
  {
    "code" : "Composition",
    "param" : ["author"]
  },
  {
    "code" : "ConceptMap"
  },
  {
    "code" : "Condition"
  },
  {
    "code" : "ConditionDefinition"
  },
  {
    "code" : "Consent"
  },
  {
    "code" : "Contract"
  },
  {
    "code" : "Coverage"
  },
  {
    "code" : "CoverageEligibilityRequest"
  },
  {
    "code" : "CoverageEligibilityResponse"
  },
  {
    "code" : "DetectedIssue",
    "param" : ["author"]
  },
  {
    "code" : "Device"
  },
  {
    "code" : "DeviceDefinition"
  },
  {
    "code" : "DeviceDispense"
  },
  {
    "code" : "DeviceMetric"
  },
  {
    "code" : "DeviceRequest",
    "param" : ["subject",
    "requester",
    "performer"]
  },
  {
    "code" : "DeviceUsage"
  },
  {
    "code" : "DiagnosticReport",
    "param" : ["subject"]
  },
  {
    "code" : "DocumentManifest",
    "param" : ["subject",
    "author"]
  },
  {
    "code" : "DocumentReference",
    "param" : ["subject",
    "author"]
  },
  {
    "code" : "Encounter"
  },
  {
    "code" : "Endpoint"
  },
  {
    "code" : "EnrollmentRequest"
  },
  {
    "code" : "EnrollmentResponse"
  },
  {
    "code" : "EpisodeOfCare"
  },
  {
    "code" : "EventDefinition"
  },
  {
    "code" : "Evidence"
  },
  {
    "code" : "EvidenceReport"
  },
  {
    "code" : "EvidenceVariable"
  },
  {
    "code" : "ExampleScenario"
  },
  {
    "code" : "ExplanationOfBenefit",
    "param" : ["procedure-udi",
    "item-udi",
    "detail-udi",
    "subdetail-udi"]
  },
  {
    "code" : "FamilyMemberHistory"
  },
  {
    "code" : "Flag",
    "param" : ["author"]
  },
  {
    "code" : "FormularyItem"
  },
  {
    "code" : "GenomicStudy"
  },
  {
    "code" : "Goal"
  },
  {
    "code" : "GraphDefinition"
  },
  {
    "code" : "Group",
    "param" : ["member"]
  },
  {
    "code" : "GuidanceResponse"
  },
  {
    "code" : "HealthcareService"
  },
  {
    "code" : "ImagingSelection"
  },
  {
    "code" : "ImagingStudy"
  },
  {
    "code" : "Immunization"
  },
  {
    "code" : "ImmunizationEvaluation"
  },
  {
    "code" : "ImmunizationRecommendation"
  },
  {
    "code" : "ImplementationGuide"
  },
  {
    "code" : "Ingredient"
  },
  {
    "code" : "InsurancePlan"
  },
  {
    "code" : "InventoryReport"
  },
  {
    "code" : "Invoice",
    "param" : ["participant"]
  },
  {
    "code" : "Library"
  },
  {
    "code" : "Linkage"
  },
  {
    "code" : "List",
    "param" : ["subject",
    "source"]
  },
  {
    "code" : "Location"
  },
  {
    "code" : "ManufacturedItemDefinition"
  },
  {
    "code" : "Measure"
  },
  {
    "code" : "MeasureReport"
  },
  {
    "code" : "Medication"
  },
  {
    "code" : "MedicationAdministration",
    "param" : ["device"]
  },
  {
    "code" : "MedicationDispense"
  },
  {
    "code" : "MedicationKnowledge"
  },
  {
    "code" : "MedicationRequest"
  },
  {
    "code" : "MedicationUsage"
  },
  {
    "code" : "MedicinalProductDefinition"
  },
  {
    "code" : "MessageDefinition"
  },
  {
    "code" : "MessageHeader",
    "param" : ["target"]
  },
  {
    "code" : "MolecularSequence"
  },
  {
    "code" : "NamingSystem"
  },
  {
    "code" : "NutritionIntake"
  },
  {
    "code" : "NutritionOrder"
  },
  {
    "code" : "NutritionProduct"
  },
  {
    "code" : "Observation",
    "param" : ["subject",
    "device"]
  },
  {
    "code" : "ObservationDefinition"
  },
  {
    "code" : "OperationDefinition"
  },
  {
    "code" : "OperationOutcome"
  },
  {
    "code" : "Organization"
  },
  {
    "code" : "OrganizationAffiliation"
  },
  {
    "code" : "PackagedProductDefinition"
  },
  {
    "code" : "Patient"
  },
  {
    "code" : "PaymentNotice"
  },
  {
    "code" : "PaymentReconciliation"
  },
  {
    "code" : "Permission"
  },
  {
    "code" : "Person"
  },
  {
    "code" : "PlanDefinition"
  },
  {
    "code" : "Practitioner"
  },
  {
    "code" : "PractitionerRole"
  },
  {
    "code" : "Procedure"
  },
  {
    "code" : "Provenance",
    "param" : ["agent"]
  },
  {
    "code" : "Questionnaire"
  },
  {
    "code" : "QuestionnaireResponse",
    "param" : ["author"]
  },
  {
    "code" : "RegulatedAuthorization"
  },
  {
    "code" : "RelatedPerson"
  },
  {
    "code" : "RequestOrchestration",
    "param" : ["author"]
  },
  {
    "code" : "Requirements"
  },
  {
    "code" : "ResearchStudy"
  },
  {
    "code" : "ResearchSubject",
    "param" : ["subject"]
  },
  {
    "code" : "RiskAssessment",
    "param" : ["performer"]
  },
  {
    "code" : "Schedule",
    "param" : ["actor"]
  },
  {
    "code" : "SearchParameter"
  },
  {
    "code" : "ServiceRequest",
    "param" : ["performer",
    "requester"]
  },
  {
    "code" : "Slot"
  },
  {
    "code" : "Specimen",
    "param" : ["subject"]
  },
  {
    "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" : "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.