Conformance
This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
STU
3).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
Continuous
Integration
Build
of
available
versions,
see
FHIR
(will
be
incorrect/inconsistent
at
times).
See
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
| Responsible Owner: FHIR Infrastructure Work Group |
|
Raw JSON ( canonical form + also see JSON Format Specification )
Compartment Definition for patient
{
"resourceType": "CompartmentDefinition",
"id": "patient",
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
"resourceType" : "CompartmentDefinition",
"id" : "patient",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CompartmentDefinition patient</b></p><a name=\"patient\"> </a><a name=\"hcpatient\"> </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=\"account.html\">Account</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"adverseevent.html\">AdverseEvent</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"allergyintolerance.html\">AllergyIntolerance</a></td><td>patient, asserter</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>patient</td></tr>\r\n <tr><td><a href=\"basic.html\">Basic</a></td><td>patient, author</td></tr>\r\n <tr><td><a href=\"biologicallyderivedproduct.html\">BiologicallyDerivedProduct</a></td><td>patient</td></tr>\r\n <tr><td><a href=\"bodystructure.html\">BodyStructure</a></td><td>patient</td></tr>\r\n <tr><td><a href=\"careplan.html\">CarePlan</a></td><td>patient</td></tr>\r\n <tr><td><a href=\"careteam.html\">CareTeam</a></td><td>patient, participant</td></tr>\r\n <tr><td><a href=\"claim.html\">Claim</a></td><td>subject, payee</td></tr>\r\n <tr><td><a href=\"claimresponse.html\">ClaimResponse</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, sender, recipient</td></tr>\r\n <tr><td><a href=\"communicationrequest.html\">CommunicationRequest</a></td><td>subject, information-provider, recipient, requester</td></tr>\r\n <tr><td><a href=\"composition.html\">Composition</a></td><td>subject, author, attester</td></tr>\r\n <tr><td><a href=\"condition.html\">Condition</a></td><td>patient, asserter</td></tr>\r\n <tr><td><a href=\"consent.html\">Consent</a></td><td>subject</td></tr>\r\n <tr><td><a href=\"contract.html\">Contract</a></td><td>patient</td></tr>\r\n <tr><td><a href=\"coverage.html\">Coverage</a></td><td>policy-holder, subscriber, beneficiary, paymentby-party</td></tr>\r\n <tr><td><a href=\"coverageeligibilityrequest.html\">CoverageEligibilityRequest</a></td><td>patient</td></tr>\r\n <tr><td><a href=\"coverageeligibilityresponse.html\">CoverageEligibilityResponse</a></td><td>patient</td></tr>\r\n <tr><td><a href=\"detectedissue.html\">DetectedIssue</a></td><td>patient</td></tr>\r\n <tr><td><a href=\"devicealert.html\">DeviceAlert</a></td><td>subject, acknowledged-by</td></tr>\r\n <tr><td><a href=\"deviceassociation.html\">DeviceAssociation</a></td><td>patient, subject, focus</td></tr>\r\n <tr><td><a href=\"devicerequest.html\">DeviceRequest</a></td><td>subject, performer, 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>subject, author</td></tr>\r\n <tr><td><a href=\"encounter.html\">Encounter</a></td><td>patient</td></tr>\r\n <tr><td><a href=\"enrollmentrequest.html\">EnrollmentRequest</a></td><td>patient</td></tr>\r\n <tr><td><a href=\"enrollmentresponse.html\">EnrollmentResponse</a></td><td>patient</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, payee</td></tr>\r\n <tr><td><a href=\"familymemberhistory.html\">FamilyMemberHistory</a></td><td>patient</td></tr>\r\n <tr><td><a href=\"flag.html\">Flag</a></td><td>patient</td></tr>\r\n <tr><td><a href=\"genomicstudy.html\">GenomicStudy</a></td><td>patient</td></tr>\r\n <tr><td><a href=\"goal.html\">Goal</a></td><td>patient</td></tr>\r\n <tr><td><a href=\"group.html\">Group</a></td><td>member</td></tr>\r\n <tr><td><a href=\"guidanceresponse.html\">GuidanceResponse</a></td><td>patient</td></tr>\r\n <tr><td><a href=\"imagingselection.html\">ImagingSelection</a></td><td>patient</td></tr>\r\n <tr><td><a href=\"imagingstudy.html\">ImagingStudy</a></td><td>patient</td></tr>\r\n <tr><td><a href=\"immunization.html\">Immunization</a></td><td>patient</td></tr>\r\n <tr><td><a href=\"invoice.html\">Invoice</a></td><td>subject, patient, recipient</td></tr>\r\n <tr><td><a href=\"list.html\">List</a></td><td>subject, source</td></tr>\r\n <tr><td><a href=\"measurereport.html\">MeasureReport</a></td><td>patient</td></tr>\r\n <tr><td><a href=\"medicationadministration.html\">MedicationAdministration</a></td><td>patient, subject</td></tr>\r\n <tr><td><a href=\"medicationdispense.html\">MedicationDispense</a></td><td>subject, patient, receiver</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, source</td></tr>\r\n <tr><td><a href=\"nutritionorder.html\">NutritionOrder</a></td><td>patient</td></tr>\r\n <tr><td><a href=\"observation.html\">Observation</a></td><td>subject, performer</td></tr>\r\n <tr><td><a href=\"patient.html\">Patient</a></td><td>{def}, link</td></tr>\r\n <tr><td><a href=\"person.html\">Person</a></td><td>patient</td></tr>\r\n <tr><td><a href=\"procedure.html\">Procedure</a></td><td>patient, performer</td></tr>\r\n <tr><td><a href=\"provenance.html\">Provenance</a></td><td>patient</td></tr>\r\n <tr><td><a href=\"questionnaireresponse.html\">QuestionnaireResponse</a></td><td>subject, author</td></tr>\r\n <tr><td><a href=\"relatedperson.html\">RelatedPerson</a></td><td>patient</td></tr>\r\n <tr><td><a href=\"requestorchestration.html\">RequestOrchestration</a></td><td>subject, participant</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=\"schedule.html\">Schedule</a></td><td>actor</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>patient, focus-reference</td></tr>\r\n <tr><td><a href=\"visionprescription.html\">VisionPrescription</a></td><td>patient</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=\"artifactassessment.html\">ArtifactAssessment</a></li>\r\n <li><a href=\"binary.html\">Binary</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=\"conceptmap.html\">ConceptMap</a></li>\r\n <li><a href=\"conditiondefinition.html\">ConditionDefinition</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=\"formularyitem.html\">FormularyItem</a></li>\r\n <li><a href=\"healthcareservice.html\">HealthcareService</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=\"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=\"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=\"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=\"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=\"regulatedauthorization.html\">RegulatedAuthorization</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=\"terminologycapabilities.html\">TerminologyCapabilities</a></li>\r\n <li><a href=\"valueset.html\">ValueSet</a></li>\r\n</ul></div>"
},
"url": "http://hl7.org/fhir/CompartmentDefinition/patient",
"name": "Base FHIR compartment definition for Patient",
"status": "draft",
"experimental": true,
"date": "2019-10-24T11:53:00+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",
"agent.patient",
"entity.patient"
]
},
{
"code": "Basic",
"param": [
"patient",
"author"
]
},
{
"code": "Binary"
},
{
"code": "BodySite",
"param": [
"patient"
]
},
{
"code": "Bundle"
},
{
"code": "CapabilityStatement"
},
{
"code": "CarePlan",
"param": [
"patient",
"performer"
]
},
{
"code": "CareTeam",
"param": [
"patient",
"participant"
]
},
{
"code": "ChargeItem",
"param": [
"subject"
]
},
{
"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": "DataElement"
},
{
"code": "DetectedIssue",
"param": [
"patient"
]
},
{
"code": "Device"
},
{
"code": "DeviceComponent"
},
{
"code": "DeviceMetric"
},
{
"code": "DeviceRequest",
"param": [
"subject",
"requester",
"performer"
]
},
{
"code": "DeviceUseStatement",
"param": [
"subject"
]
},
{
"code": "DiagnosticReport",
"param": [
"subject"
]
},
{
"code": "DocumentManifest",
"param": [
"subject",
"author",
"recipient"
]
},
{
"code": "DocumentReference",
"param": [
"subject",
"author"
]
},
{
"code": "EligibilityRequest",
"param": [
"patient"
]
},
{
"code": "EligibilityResponse"
},
{
"code": "Encounter",
"param": [
"patient"
]
},
{
"code": "Endpoint"
},
{
"code": "EnrollmentRequest",
"param": [
"subject"
]
},
{
"code": "EnrollmentResponse"
},
{
"code": "EpisodeOfCare",
"param": [
"patient"
]
},
{
"code": "ExpansionProfile"
},
{
"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": "ImagingManifest",
"param": [
"patient",
"author"
]
},
{
"code": "ImagingStudy",
"param": [
"patient"
]
},
{
"code": "Immunization",
"param": [
"patient"
]
},
{
"code": "ImmunizationRecommendation",
"param": [
"patient"
]
},
{
"code": "ImplementationGuide"
},
{
"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": "MedicationRequest",
"param": [
"subject"
]
},
{
"code": "MedicationStatement",
"param": [
"subject"
]
},
{
"code": "MessageDefinition"
},
{
"code": "MessageHeader"
},
{
"code": "NamingSystem"
},
{
"code": "NutritionOrder",
"param": [
"patient"
]
},
{
"code": "Observation",
"param": [
"subject",
"performer"
]
},
{
"code": "OperationDefinition"
},
{
"code": "OperationOutcome"
},
{
"code": "Organization"
},
{
"code": "Patient",
"param": [
"link"
]
},
{
"code": "PaymentNotice"
},
{
"code": "PaymentReconciliation"
},
{
"code": "Person",
"param": [
"patient"
]
},
{
"code": "PlanDefinition"
},
{
"code": "Practitioner"
},
{
"code": "PractitionerRole"
},
{
"code": "Procedure",
"param": [
"patient",
"performer"
]
},
{
"code": "ProcedureRequest",
"param": [
"subject",
"performer"
]
},
{
"code": "ProcessRequest"
},
{
"code": "ProcessResponse"
},
{
"code": "Provenance",
"param": [
"target.subject",
"target.patient",
"patient"
]
},
{
"code": "Questionnaire"
},
{
"code": "QuestionnaireResponse",
"param": [
"subject",
"author"
]
},
{
"code": "ReferralRequest",
"param": [
"patient",
"requester"
]
},
{
"code": "RelatedPerson",
"param": [
"patient"
]
},
{
"code": "RequestGroup",
"param": [
"subject",
"participant"
]
},
{
"code": "ResearchStudy"
},
{
"code": "ResearchSubject",
"param": [
"individual"
]
},
{
"code": "RiskAssessment",
"param": [
"subject"
]
},
{
"code": "Schedule",
"param": [
"actor"
]
},
{
"code": "SearchParameter"
},
{
"code": "Sequence"
},
{
"code": "ServiceDefinition"
},
{
"code": "Slot"
},
{
"code": "Specimen",
"param": [
"subject"
]
},
{
"code": "StructureDefinition"
},
{
"code": "StructureMap"
},
{
"code": "Subscription"
},
{
"code": "Substance"
},
{
"code": "SupplyDelivery",
"param": [
"patient"
]
},
{
"code": "SupplyRequest",
"param": [
"requester"
]
},
{
"code": "Task"
},
{
"code": "TestReport"
},
{
"code": "TestScript"
},
{
"code": "ValueSet"
},
{
"code": "VisionPrescription",
"param": [
"patient"
]
}
]
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
}],
"url" : "http://hl7.org/fhir/CompartmentDefinition/patient",
"version" : "6.0.0-ballot3",
"name" : "Base FHIR compartment definition for Patient",
"status" : "draft",
"experimental" : false,
"date" : "2025-11-09T02:03:16+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 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 resource, the records associated with the linked patient resource will not be returned as part of the compartment search. Those records will be returned only with another compartment search using the \"id\" for the linked patient resource.\n \nIn cases where two patients have been merged rather than linked, associated resources should be moved to the target patient as part of the merge process, so the patient compartment for the target patient would include all relevant data, and the patient compartment for the source patient would include only the linked Patient and possibly remnant resources like AuditEvent.. The set of resources associated with a particular patient",
"code" : "Patient",
"search" : true,
"resource" : [{
"code" : "Account",
"param" : ["subject"],
"startParam" : "period",
"endParam" : "period"
},
{
"code" : "ActivityDefinition"
},
{
"code" : "ActorDefinition"
},
{
"code" : "AdministrableProductDefinition"
},
{
"code" : "AdverseEvent",
"param" : ["subject"],
"startParam" : "occurrence",
"endParam" : "occurrence"
},
{
"code" : "AllergyIntolerance",
"param" : ["patient",
"asserter"],
"startParam" : "date",
"endParam" : "date"
},
{
"code" : "Appointment",
"param" : ["actor"],
"startParam" : "date",
"endParam" : "date"
},
{
"code" : "AppointmentResponse",
"param" : ["actor"]
},
{
"code" : "ArtifactAssessment",
"startParam" : "date",
"endParam" : "date"
},
{
"code" : "AuditEvent",
"param" : ["patient"],
"startParam" : "date",
"endParam" : "date"
},
{
"code" : "Basic",
"param" : ["patient",
"author"],
"startParam" : "created",
"endParam" : "created"
},
{
"code" : "Binary"
},
{
"code" : "BiologicallyDerivedProduct",
"param" : ["patient"]
},
{
"code" : "BodyStructure",
"param" : ["patient"]
},
{
"code" : "Bundle"
},
{
"code" : "CapabilityStatement"
},
{
"code" : "CarePlan",
"param" : ["patient"],
"startParam" : "date",
"endParam" : "date"
},
{
"code" : "CareTeam",
"param" : ["patient",
"participant"],
"startParam" : "date",
"endParam" : "date"
},
{
"code" : "Claim",
"param" : ["subject",
"payee"],
"startParam" : "created",
"endParam" : "created"
},
{
"code" : "ClaimResponse",
"param" : ["subject"],
"startParam" : "created",
"endParam" : "created"
},
{
"code" : "ClinicalAssessment",
"param" : ["subject"],
"startParam" : "date",
"endParam" : "date"
},
{
"code" : "ClinicalUseDefinition"
},
{
"code" : "CodeSystem"
},
{
"code" : "Communication",
"param" : ["subject",
"sender",
"recipient"],
"startParam" : "sent",
"endParam" : "sent"
},
{
"code" : "CommunicationRequest",
"param" : ["subject",
"information-provider",
"recipient",
"requester"],
"startParam" : "authored",
"endParam" : "authored"
},
{
"code" : "CompartmentDefinition"
},
{
"code" : "Composition",
"param" : ["subject",
"author",
"attester"],
"startParam" : "date",
"endParam" : "date"
},
{
"code" : "ConceptMap"
},
{
"code" : "Condition",
"param" : ["patient",
"asserter"]
},
{
"code" : "ConditionDefinition",
"startParam" : "date",
"endParam" : "date"
},
{
"code" : "Consent",
"param" : ["subject"],
"startParam" : "period",
"endParam" : "period"
},
{
"code" : "Contract",
"param" : ["patient"]
},
{
"code" : "Coverage",
"param" : ["policy-holder",
"subscriber",
"beneficiary",
"paymentby-party"],
"startParam" : "period",
"endParam" : "period"
},
{
"code" : "CoverageEligibilityRequest",
"param" : ["patient"],
"startParam" : "created",
"endParam" : "created"
},
{
"code" : "CoverageEligibilityResponse",
"param" : ["patient"],
"startParam" : "created",
"endParam" : "created"
},
{
"code" : "DetectedIssue",
"param" : ["patient"],
"startParam" : "identified",
"endParam" : "identified"
},
{
"code" : "Device"
},
{
"code" : "DeviceAlert",
"param" : ["subject",
"acknowledged-by"],
"startParam" : "occurrence",
"endParam" : "occurrence"
},
{
"code" : "DeviceAssociation",
"param" : ["patient",
"subject",
"focus"],
"startParam" : "date",
"endParam" : "date"
},
{
"code" : "DeviceDefinition"
},
{
"code" : "DeviceMetric"
},
{
"code" : "DeviceRequest",
"param" : ["subject",
"performer",
"requester"],
"startParam" : "event-date",
"endParam" : "event-date"
},
{
"code" : "DiagnosticReport",
"param" : ["subject"],
"startParam" : "date",
"endParam" : "date"
},
{
"code" : "DocumentReference",
"param" : ["subject",
"author"],
"startParam" : "date",
"endParam" : "date"
},
{
"code" : "Encounter",
"param" : ["patient"],
"startParam" : "date-start",
"endParam" : "date-start"
},
{
"code" : "Endpoint"
},
{
"code" : "EnrollmentRequest",
"param" : ["patient"]
},
{
"code" : "EnrollmentResponse",
"param" : ["patient"]
},
{
"code" : "EpisodeOfCare",
"param" : ["subject"],
"startParam" : "date",
"endParam" : "date"
},
{
"code" : "EventDefinition"
},
{
"code" : "Evidence"
},
{
"code" : "EvidenceVariable"
},
{
"code" : "ExampleScenario"
},
{
"code" : "ExplanationOfBenefit",
"param" : ["subject",
"payee"],
"startParam" : "created",
"endParam" : "created"
},
{
"code" : "FamilyMemberHistory",
"param" : ["patient"],
"startParam" : "date",
"endParam" : "date"
},
{
"code" : "Flag",
"param" : ["patient"],
"startParam" : "date",
"endParam" : "date"
},
{
"code" : "FormularyItem"
},
{
"code" : "GenomicStudy",
"param" : ["patient"]
},
{
"code" : "Goal",
"param" : ["patient"],
"startParam" : "start-date",
"endParam" : "start-date"
},
{
"code" : "Group",
"param" : ["member"]
},
{
"code" : "GuidanceResponse",
"param" : ["patient"]
},
{
"code" : "HealthcareService"
},
{
"code" : "ImagingSelection",
"param" : ["patient"],
"startParam" : "issued",
"endParam" : "issued"
},
{
"code" : "ImagingStudy",
"param" : ["patient"],
"startParam" : "started",
"endParam" : "started"
},
{
"code" : "Immunization",
"param" : ["patient"],
"startParam" : "date",
"endParam" : "date"
},
{
"code" : "ImplementationGuide"
},
{
"code" : "Ingredient"
},
{
"code" : "InsurancePlan"
},
{
"code" : "InsuranceProduct"
},
{
"code" : "Invoice",
"param" : ["subject",
"patient",
"recipient"],
"startParam" : "date",
"endParam" : "date"
},
{
"code" : "Library"
},
{
"code" : "Linkage"
},
{
"code" : "List",
"param" : ["subject",
"source"],
"startParam" : "date",
"endParam" : "date"
},
{
"code" : "Location"
},
{
"code" : "ManufacturedItemDefinition"
},
{
"code" : "Measure"
},
{
"code" : "MeasureReport",
"param" : ["patient"],
"startParam" : "date",
"endParam" : "date"
},
{
"code" : "Medication"
},
{
"code" : "MedicationAdministration",
"param" : ["patient",
"subject"],
"startParam" : "date",
"endParam" : "date"
},
{
"code" : "MedicationDispense",
"param" : ["subject",
"patient",
"receiver"],
"startParam" : "whenhandedover",
"endParam" : "whenhandedover"
},
{
"code" : "MedicationKnowledge"
},
{
"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" : "MolecularDefinition"
},
{
"code" : "NamingSystem"
},
{
"code" : "NutritionIntake",
"param" : ["subject",
"source"],
"startParam" : "date",
"endParam" : "date"
},
{
"code" : "NutritionOrder",
"param" : ["patient"],
"startParam" : "datetime",
"endParam" : "datetime"
},
{
"code" : "NutritionProduct"
},
{
"code" : "Observation",
"param" : ["subject",
"performer"],
"startParam" : "date",
"endParam" : "date"
},
{
"code" : "ObservationDefinition"
},
{
"code" : "OperationDefinition"
},
{
"code" : "OperationOutcome"
},
{
"code" : "Organization"
},
{
"code" : "OrganizationAffiliation",
"startParam" : "date",
"endParam" : "date"
},
{
"code" : "PackagedProductDefinition"
},
{
"code" : "Patient",
"param" : ["{def}",
"link"]
},
{
"code" : "PaymentNotice",
"startParam" : "created",
"endParam" : "created"
},
{
"code" : "PaymentReconciliation",
"startParam" : "created",
"endParam" : "created"
},
{
"code" : "Permission",
"startParam" : "rule-data-period",
"endParam" : "rule-data-period"
},
{
"code" : "Person",
"param" : ["patient"]
},
{
"code" : "PlanDefinition"
},
{
"code" : "Practitioner"
},
{
"code" : "PractitionerRole",
"startParam" : "date",
"endParam" : "date"
},
{
"code" : "Procedure",
"param" : ["patient",
"performer"],
"startParam" : "date",
"endParam" : "date"
},
{
"code" : "Provenance",
"param" : ["patient"],
"startParam" : "when",
"endParam" : "when"
},
{
"code" : "Questionnaire"
},
{
"code" : "QuestionnaireResponse",
"param" : ["subject",
"author"],
"startParam" : "answer-date",
"endParam" : "answer-date"
},
{
"code" : "RegulatedAuthorization"
},
{
"code" : "RelatedPerson",
"param" : ["patient"]
},
{
"code" : "RequestOrchestration",
"param" : ["subject",
"participant"]
},
{
"code" : "Requirements"
},
{
"code" : "ResearchStudy",
"startParam" : "date",
"endParam" : "date"
},
{
"code" : "ResearchSubject",
"param" : ["subject"],
"startParam" : "date",
"endParam" : "date"
},
{
"code" : "RiskAssessment",
"param" : ["subject"],
"startParam" : "date",
"endParam" : "date"
},
{
"code" : "Schedule",
"param" : ["actor"],
"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" : "StructureMap"
},
{
"code" : "Subscription"
},
{
"code" : "SubscriptionStatus"
},
{
"code" : "SubscriptionTopic"
},
{
"code" : "Substance"
},
{
"code" : "SubstanceDefinition"
},
{
"code" : "Task",
"param" : ["patient",
"focus-reference"],
"startParam" : "period",
"endParam" : "period"
},
{
"code" : "TerminologyCapabilities"
},
{
"code" : "ValueSet"
},
{
"code" : "VisionPrescription",
"param" : ["patient"],
"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.
FHIR
®©
HL7.org
2011+.
FHIR
Release
3
(STU;
v3.0.2-11200)
R6
hl7.fhir.core#6.0.0-ballot3
generated
on
Thurs,
Oct
24,
2019
11:53+1100.
QA
Page
Sun,
Nov
9,
2025
02:04+0000.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
Glossary
|
QA
|
Compare
to
DSTU2
R4
|
Compare
to
R5
|
Compare
to
Last
Ballot
|
|
Propose
a
change