FHIR Release 3 (STU)
ConformanceThis 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 of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3
| FHIR Infrastructure Work Group | Maturity Level: N/A | Ballot Status: Informative |
Base Capability Statement
{
"resourceType": "CapabilityStatement",
"id": "base",
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/CapabilityStatement/base",
"version": "3.0.2-11200",
"name": "Base FHIR Capability Statement (Full)",
"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": "This is the base Capability Statement for FHIR. It represents a server that provides the full set of functionality defined by FHIR. It is provided to use as a template for system designers to build their own Capability Statements from",
"kind": "capability",
"software": {
"name": "Insert your softwware name here..."
},
"fhirVersion": "3.0.2",
"acceptUnknown": "both",
"format": [
"xml",
"json"
],
"rest": [
{
"mode": "server",
"documentation": "All the functionality defined in FHIR",
"security": {
"cors": true,
"service": [
{
"coding": [
{
"system": "http://hl7.org/fhir/restful-security-service",
"code": "SMART-on-FHIR",
"display": "SMART-on-FHIR"
}
],
"text": "See http://docs.smarthealthit.org/"
}
],
"description": "This is the Capability Statement to declare that the server supports SMART-on-FHIR. See the SMART-on-FHIR docs for the extension that would go with such a server"
},
"resource": [
{
"type": "Account",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Account"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Account.owner",
"Account.subject",
"Account.patient"
],
"searchRevInclude": [
"ChargeItem.account"
],
"searchParam": [
{
"name": "owner",
"definition": "http://hl7.org/fhir/SearchParameter/Account-owner",
"type": "reference",
"documentation": "Who is responsible?"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Account-identifier",
"type": "token",
"documentation": "Account number"
},
{
"name": "period",
"definition": "http://hl7.org/fhir/SearchParameter/Account-period",
"type": "date",
"documentation": "Transaction window"
},
{
"name": "balance",
"definition": "http://hl7.org/fhir/SearchParameter/Account-balance",
"type": "quantity",
"documentation": "How much is in account?"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/Account-subject",
"type": "reference",
"documentation": "What is account tied to?"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/Account-patient",
"type": "reference",
"documentation": "What is account tied to?"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/Account-name",
"type": "string",
"documentation": "Human-readable label"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/Account-type",
"type": "token",
"documentation": "E.g. patient, expense, depreciation"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Account-status",
"type": "token",
"documentation": "active | inactive | entered-in-error"
}
]
},
{
"type": "ActivityDefinition",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/ActivityDefinition"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"ActivityDefinition.successor",
"ActivityDefinition.derived-from",
"ActivityDefinition.predecessor",
"ActivityDefinition.composed-of",
"ActivityDefinition.depends-on"
],
"searchRevInclude": [
"Communication.definition",
"DeviceRequest.definition",
"Procedure.definition",
"ProcedureRequest.definition",
"ReferralRequest.definition"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-date",
"type": "date",
"documentation": "The activity definition publication date"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-identifier",
"type": "token",
"documentation": "External identifier for the activity definition"
},
{
"name": "successor",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-successor",
"type": "reference",
"documentation": "What resource is being referenced"
},
{
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the activity definition"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-description",
"type": "string",
"documentation": "The description of the activity definition"
},
{
"name": "derived-from",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-derived-from",
"type": "reference",
"documentation": "What resource is being referenced"
},
{
"name": "predecessor",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-predecessor",
"type": "reference",
"documentation": "What resource is being referenced"
},
{
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-title",
"type": "string",
"documentation": "The human-friendly name of the activity definition"
},
{
"name": "composed-of",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-composed-of",
"type": "reference",
"documentation": "What resource is being referenced"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-version",
"type": "token",
"documentation": "The business version of the activity definition"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-url",
"type": "uri",
"documentation": "The uri that identifies the activity definition"
},
{
"name": "effective",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-effective",
"type": "date",
"documentation": "The time during which the activity definition is intended to be in use"
},
{
"name": "depends-on",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-depends-on",
"type": "reference",
"documentation": "What resource is being referenced"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-name",
"type": "string",
"documentation": "Computationally friendly name of the activity definition"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-publisher",
"type": "string",
"documentation": "Name of the publisher of the activity definition"
},
{
"name": "topic",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-topic",
"type": "token",
"documentation": "Topics associated with the module"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-status",
"type": "token",
"documentation": "The current status of the activity definition"
}
]
},
{
"type": "AdverseEvent",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/AdverseEvent"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"AdverseEvent.recorder",
"AdverseEvent.study",
"AdverseEvent.reaction",
"AdverseEvent.subject",
"AdverseEvent.substance",
"AdverseEvent.location"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/AdverseEvent-date",
"type": "date",
"documentation": "When the event occurred"
},
{
"name": "recorder",
"definition": "http://hl7.org/fhir/SearchParameter/AdverseEvent-recorder",
"type": "reference",
"documentation": "Who recorded the adverse event"
},
{
"name": "study",
"definition": "http://hl7.org/fhir/SearchParameter/AdverseEvent-study",
"type": "reference",
"documentation": "AdverseEvent.study"
},
{
"name": "reaction",
"definition": "http://hl7.org/fhir/SearchParameter/AdverseEvent-reaction",
"type": "reference",
"documentation": "Adverse Reaction Events linked to exposure to substance"
},
{
"name": "seriousness",
"definition": "http://hl7.org/fhir/SearchParameter/AdverseEvent-seriousness",
"type": "token",
"documentation": "Mild | Moderate | Severe"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/AdverseEvent-subject",
"type": "reference",
"documentation": "Subject or group impacted by event"
},
{
"name": "substance",
"definition": "http://hl7.org/fhir/SearchParameter/AdverseEvent-substance",
"type": "reference",
"documentation": "Refers to the specific entity that caused the adverse event"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/AdverseEvent-location",
"type": "reference",
"documentation": "Location where adverse event occurred"
},
{
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/AdverseEvent-category",
"type": "token",
"documentation": "AE | PAE \rAn adverse event is an event that caused harm to a patient, an adverse reaction is a something that is a subject-specific event that is a result of an exposure to a medication, food, device or environmental substance, a potential adverse event is something that occurred and that could have caused harm to a patient but did not"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/AdverseEvent-type",
"type": "token",
"documentation": "actual | potential"
}
]
},
{
"type": "AllergyIntolerance",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"AllergyIntolerance.recorder",
"AllergyIntolerance.asserter",
"AllergyIntolerance.patient"
],
"searchRevInclude": [
"ClinicalImpression.problem",
"ImmunizationRecommendation.information"
],
"searchParam": [
{
"name": "severity",
"definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-severity",
"type": "token",
"documentation": "mild | moderate | severe (of event as a whole)"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"type": "date",
"documentation": "Date record was believed accurate"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "External ids for this item"
},
{
"name": "manifestation",
"definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-manifestation",
"type": "token",
"documentation": "Clinical symptoms/signs associated with the Event"
},
{
"name": "recorder",
"definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-recorder",
"type": "reference",
"documentation": "Who recorded the sensitivity"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"type": "token",
"documentation": "Code that identifies the allergy or intolerance"
},
{
"name": "verification-status",
"definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-verification-status",
"type": "token",
"documentation": "unconfirmed | confirmed | refuted | entered-in-error"
},
{
"name": "criticality",
"definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-criticality",
"type": "token",
"documentation": "low | high | unable-to-assess"
},
{
"name": "clinical-status",
"definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-clinical-status",
"type": "token",
"documentation": "active | inactive | resolved"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-type",
"type": "token",
"documentation": "allergy | intolerance - Underlying mechanism (if known)"
},
{
"name": "onset",
"definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-onset",
"type": "date",
"documentation": "Date(/time) when manifestations showed"
},
{
"name": "route",
"definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-route",
"type": "token",
"documentation": "How the subject was exposed to the substance"
},
{
"name": "asserter",
"definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-asserter",
"type": "reference",
"documentation": "Source of the information about the allergy"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Who the sensitivity is for"
},
{
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-category",
"type": "token",
"documentation": "food | medication | environment | biologic"
},
{
"name": "last-date",
"definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-last-date",
"type": "date",
"documentation": "Date(/time) of last known occurrence of a reaction"
}
]
},
{
"type": "Appointment",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Appointment"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Appointment.actor",
"Appointment.practitioner",
"Appointment.incomingreferral",
"Appointment.patient",
"Appointment.location"
],
"searchRevInclude": [
"AppointmentResponse.appointment",
"CarePlan.activity-reference",
"ClinicalImpression.action",
"Encounter.appointment"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/Appointment-date",
"type": "date",
"documentation": "Appointment date/time."
},
{
"name": "actor",
"definition": "http://hl7.org/fhir/SearchParameter/Appointment-actor",
"type": "reference",
"documentation": "Any one of the individuals participating in the appointment"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Appointment-identifier",
"type": "token",
"documentation": "An Identifier of the Appointment"
},
{
"name": "practitioner",
"definition": "http://hl7.org/fhir/SearchParameter/Appointment-practitioner",
"type": "reference",
"documentation": "One of the individuals of the appointment is this practitioner"
},
{
"name": "incomingreferral",
"definition": "http://hl7.org/fhir/SearchParameter/Appointment-incomingreferral",
"type": "reference",
"documentation": "The ReferralRequest provided as information to allocate to the Encounter"
},
{
"name": "part-status",
"definition": "http://hl7.org/fhir/SearchParameter/Appointment-part-status",
"type": "token",
"documentation": "The Participation status of the subject, or other participant on the appointment. Can be used to locate participants that have not responded to meeting requests."
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/Appointment-patient",
"type": "reference",
"documentation": "One of the individuals of the appointment is this patient"
},
{
"name": "appointment-type",
"definition": "http://hl7.org/fhir/SearchParameter/Appointment-appointment-type",
"type": "token",
"documentation": "The style of appointment or patient that has been booked in the slot (not service type)"
},
{
"name": "service-type",
"definition": "http://hl7.org/fhir/SearchParameter/Appointment-service-type",
"type": "token",
"documentation": "The specific service that is to be performed during this appointment"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/Appointment-location",
"type": "reference",
"documentation": "This location is listed in the participants of the appointment"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Appointment-status",
"type": "token",
"documentation": "The overall status of the appointment"
}
]
},
{
"type": "AppointmentResponse",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/AppointmentResponse"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"AppointmentResponse.actor",
"AppointmentResponse.practitioner",
"AppointmentResponse.patient",
"AppointmentResponse.appointment",
"AppointmentResponse.location"
],
"searchParam": [
{
"name": "actor",
"definition": "http://hl7.org/fhir/SearchParameter/AppointmentResponse-actor",
"type": "reference",
"documentation": "The Person, Location/HealthcareService or Device that this appointment response replies for"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/AppointmentResponse-identifier",
"type": "token",
"documentation": "An Identifier in this appointment response"
},
{
"name": "practitioner",
"definition": "http://hl7.org/fhir/SearchParameter/AppointmentResponse-practitioner",
"type": "reference",
"documentation": "This Response is for this Practitioner"
},
{
"name": "part-status",
"definition": "http://hl7.org/fhir/SearchParameter/AppointmentResponse-part-status",
"type": "token",
"documentation": "The participants acceptance status for this appointment"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/AppointmentResponse-patient",
"type": "reference",
"documentation": "This Response is for this Patient"
},
{
"name": "appointment",
"definition": "http://hl7.org/fhir/SearchParameter/AppointmentResponse-appointment",
"type": "reference",
"documentation": "The appointment that the response is attached to"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/AppointmentResponse-location",
"type": "reference",
"documentation": "This Response is for this Location"
}
]
},
{
"type": "AuditEvent",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/AuditEvent"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"AuditEvent.agent",
"AuditEvent.patient",
"AuditEvent.entity"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-date",
"type": "date",
"documentation": "Time when the event occurred on source"
},
{
"name": "entity-type",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-entity-type",
"type": "token",
"documentation": "Type of entity involved"
},
{
"name": "agent",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-agent",
"type": "reference",
"documentation": "Direct reference to resource"
},
{
"name": "address",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-address",
"type": "string",
"documentation": "Identifier for the network access point of the user device"
},
{
"name": "entity-role",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-entity-role",
"type": "token",
"documentation": "What role the entity played"
},
{
"name": "source",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-source",
"type": "token",
"documentation": "The identity of source detecting the event"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-type",
"type": "token",
"documentation": "Type/identifier of event"
},
{
"name": "altid",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-altid",
"type": "token",
"documentation": "Alternative User id e.g. authentication"
},
{
"name": "site",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-site",
"type": "token",
"documentation": "Logical source location within the enterprise"
},
{
"name": "agent-name",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-agent-name",
"type": "string",
"documentation": "Human-meaningful name for the agent"
},
{
"name": "entity-name",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-entity-name",
"type": "string",
"documentation": "Descriptor for entity"
},
{
"name": "subtype",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-subtype",
"type": "token",
"documentation": "More specific type/id for the event"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-patient",
"type": "reference",
"documentation": "Direct reference to resource"
},
{
"name": "action",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-action",
"type": "token",
"documentation": "Type of action performed during the event"
},
{
"name": "agent-role",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-agent-role",
"type": "token",
"documentation": "Agent role in the event"
},
{
"name": "user",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-user",
"type": "token",
"documentation": "Unique identifier for the user"
},
{
"name": "entity",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-entity",
"type": "reference",
"documentation": "Specific instance of resource"
},
{
"name": "entity-id",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-entity-id",
"type": "token",
"documentation": "Specific instance of object"
},
{
"name": "outcome",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-outcome",
"type": "token",
"documentation": "Whether the event succeeded or failed"
},
{
"name": "policy",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-policy",
"type": "uri",
"documentation": "Policy that authorized event"
}
]
},
{
"type": "Basic",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Basic"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Basic.subject",
"Basic.patient",
"Basic.author"
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Basic-identifier",
"type": "token",
"documentation": "Business identifier"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/Basic-code",
"type": "token",
"documentation": "Kind of Resource"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/Basic-subject",
"type": "reference",
"documentation": "Identifies the focus of this resource"
},
{
"name": "created",
"definition": "http://hl7.org/fhir/SearchParameter/Basic-created",
"type": "date",
"documentation": "When created"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/Basic-patient",
"type": "reference",
"documentation": "Identifies the focus of this resource"
},
{
"name": "author",
"definition": "http://hl7.org/fhir/SearchParameter/Basic-author",
"type": "reference",
"documentation": "Who created"
}
]
},
{
"type": "Binary",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Binary"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchParam": [
{
"name": "contenttype",
"definition": "http://hl7.org/fhir/SearchParameter/Binary-contenttype",
"type": "token",
"documentation": "MimeType of the binary content"
}
]
},
{
"type": "BodySite",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/BodySite"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"BodySite.patient"
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/BodySite-identifier",
"type": "token",
"documentation": "Identifier for this instance of the anatomical location"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/BodySite-code",
"type": "token",
"documentation": "Named anatomical location"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/BodySite-patient",
"type": "reference",
"documentation": "Patient to whom bodysite belongs"
}
]
},
{
"type": "Bundle",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Bundle"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Bundle.composition",
"Bundle.message"
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Bundle-identifier",
"type": "token",
"documentation": "Persistent identifier for the bundle"
},
{
"name": "composition",
"definition": "http://hl7.org/fhir/SearchParameter/Bundle-composition",
"type": "reference",
"documentation": "The first resource in the bundle, if the bundle type is \"document\" - this is a composition, and this parameter provides access to searches its contents"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/Bundle-type",
"type": "token",
"documentation": "document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection"
},
{
"name": "message",
"definition": "http://hl7.org/fhir/SearchParameter/Bundle-message",
"type": "reference",
"documentation": "The first resource in the bundle, if the bundle type is \"message\" - this is a message header, and this parameter provides access to search its contents"
}
]
},
{
"type": "CapabilityStatement",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/CapabilityStatement"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"CapabilityStatement.resource-profile",
"CapabilityStatement.supported-profile"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/CapabilityStatement-date",
"type": "date",
"documentation": "The capability statement publication date"
},
{
"name": "resource-profile",
"definition": "http://hl7.org/fhir/SearchParameter/CapabilityStatement-resource-profile",
"type": "reference",
"documentation": "A profile id invoked in a capability statement"
},
{
"name": "software",
"definition": "http://hl7.org/fhir/SearchParameter/CapabilityStatement-software",
"type": "string",
"documentation": "Part of a the name of a software application"
},
{
"name": "resource",
"definition": "http://hl7.org/fhir/SearchParameter/CapabilityStatement-resource",
"type": "token",
"documentation": "Name of a resource mentioned in a capability statement"
},
{
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/CapabilityStatement-jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the capability statement"
},
{
"name": "format",
"definition": "http://hl7.org/fhir/SearchParameter/CapabilityStatement-format",
"type": "token",
"documentation": "formats supported (xml | json | ttl | mime type)"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/CapabilityStatement-description",
"type": "string",
"documentation": "The description of the capability statement"
},
{
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/CapabilityStatement-title",
"type": "string",
"documentation": "The human-friendly name of the capability statement"
},
{
"name": "fhirversion",
"definition": "http://hl7.org/fhir/SearchParameter/CapabilityStatement-fhirversion",
"type": "token",
"documentation": "The version of FHIR"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/CapabilityStatement-version",
"type": "token",
"documentation": "The business version of the capability statement"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/CapabilityStatement-url",
"type": "uri",
"documentation": "The uri that identifies the capability statement"
},
{
"name": "supported-profile",
"definition": "http://hl7.org/fhir/SearchParameter/CapabilityStatement-supported-profile",
"type": "reference",
"documentation": "Profiles for use cases supported"
},
{
"name": "mode",
"definition": "http://hl7.org/fhir/SearchParameter/CapabilityStatement-mode",
"type": "token",
"documentation": "Mode - restful (server/client) or messaging (sender/receiver)"
},
{
"name": "security-service",
"definition": "http://hl7.org/fhir/SearchParameter/CapabilityStatement-security-service",
"type": "token",
"documentation": "OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/CapabilityStatement-name",
"type": "string",
"documentation": "Computationally friendly name of the capability statement"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/CapabilityStatement-publisher",
"type": "string",
"documentation": "Name of the publisher of the capability statement"
},
{
"name": "event",
"definition": "http://hl7.org/fhir/SearchParameter/CapabilityStatement-event",
"type": "token",
"documentation": "Event code in a capability statement"
},
{
"name": "guide",
"definition": "http://hl7.org/fhir/SearchParameter/CapabilityStatement-guide",
"type": "uri",
"documentation": "Implementation guides supported"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/CapabilityStatement-status",
"type": "token",
"documentation": "The current status of the capability statement"
}
]
},
{
"type": "CarePlan",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/CarePlan"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"CarePlan.care-team",
"CarePlan.performer",
"CarePlan.goal",
"CarePlan.subject",
"CarePlan.replaces",
"CarePlan.part-of",
"CarePlan.encounter",
"CarePlan.activity-reference",
"CarePlan.condition",
"CarePlan.based-on",
"CarePlan.patient",
"CarePlan.context",
"CarePlan.definition"
],
"searchRevInclude": [
"CarePlan.replaces",
"CarePlan.part-of",
"CarePlan.based-on",
"DiagnosticReport.based-on",
"ImagingStudy.basedon",
"Observation.based-on",
"Procedure.based-on",
"QuestionnaireResponse.based-on",
"ReferralRequest.based-on"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"type": "date",
"documentation": "Time period plan covers"
},
{
"name": "care-team",
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-care-team",
"type": "reference",
"documentation": "Who's involved in plan?"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "External Ids for this plan"
},
{
"name": "performer",
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-performer",
"type": "reference",
"documentation": "Matches if the practitioner is listed as a performer in any of the \"simple\" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.)"
},
{
"name": "goal",
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-goal",
"type": "reference",
"documentation": "Desired outcome of plan"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-subject",
"type": "reference",
"documentation": "Who care plan is for"
},
{
"name": "replaces",
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-replaces",
"type": "reference",
"documentation": "CarePlan replaced by this CarePlan"
},
{
"name": "part-of",
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-part-of",
"type": "reference",
"documentation": "Part of referenced CarePlan"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-encounter",
"type": "reference",
"documentation": "Created in context of"
},
{
"name": "intent",
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-intent",
"type": "token",
"documentation": "proposal | plan | order | option"
},
{
"name": "activity-reference",
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-activity-reference",
"type": "reference",
"documentation": "Activity details defined in specific resource"
},
{
"name": "condition",
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-condition",
"type": "reference",
"documentation": "Health issues this plan addresses"
},
{
"name": "based-on",
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-based-on",
"type": "reference",
"documentation": "Fulfills care plan"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Who care plan is for"
},
{
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-context",
"type": "reference",
"documentation": "Created in context of"
},
{
"name": "activity-date",
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-activity-date",
"type": "date",
"documentation": "Specified date occurs within period specified by CarePlan.activity.timingSchedule"
},
{
"name": "definition",
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-definition",
"type": "reference",
"documentation": "Protocol or definition"
},
{
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-category",
"type": "token",
"documentation": "Type of plan"
},
{
"name": "activity-code",
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-activity-code",
"type": "token",
"documentation": "Detail type of activity"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-status",
"type": "token",
"documentation": "draft | active | suspended | completed | entered-in-error | cancelled | unknown"
}
]
},
{
"type": "CareTeam",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/CareTeam"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"CareTeam.patient",
"CareTeam.subject",
"CareTeam.context",
"CareTeam.encounter",
"CareTeam.participant"
],
"searchRevInclude": [
"CarePlan.care-team",
"CarePlan.performer",
"CareTeam.participant",
"CommunicationRequest.recipient",
"Consent.actor"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"type": "date",
"documentation": "Time period team covers"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "External Ids for this team"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Who care team is for"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/CareTeam-subject",
"type": "reference",
"documentation": "Who care team is for"
},
{
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/CareTeam-context",
"type": "reference",
"documentation": "Encounter or episode associated with CareTeam"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/CareTeam-encounter",
"type": "reference",
"documentation": "Encounter or episode associated with CareTeam"
},
{
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/CareTeam-category",
"type": "token",
"documentation": "Type of team"
},
{
"name": "participant",
"definition": "http://hl7.org/fhir/SearchParameter/CareTeam-participant",
"type": "reference",
"documentation": "Who is involved"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/CareTeam-status",
"type": "token",
"documentation": "proposed | active | suspended | inactive | entered-in-error"
}
]
},
{
"type": "ChargeItem",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/ChargeItem"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"ChargeItem.performing-organization",
"ChargeItem.subject",
"ChargeItem.participant-actor",
"ChargeItem.patient",
"ChargeItem.service",
"ChargeItem.context",
"ChargeItem.enterer",
"ChargeItem.account",
"ChargeItem.requesting-organization"
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItem-identifier",
"type": "token",
"documentation": "Business Identifier for item"
},
{
"name": "performing-organization",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItem-performing-organization",
"type": "reference",
"documentation": "Organization providing the charged sevice"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItem-code",
"type": "token",
"documentation": "A code that identifies the charge, like a billing code"
},
{
"name": "quantity",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItem-quantity",
"type": "quantity",
"documentation": "Quantity of which the charge item has been serviced"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItem-subject",
"type": "reference",
"documentation": "Individual service was done for/to"
},
{
"name": "participant-role",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItem-participant-role",
"type": "token",
"documentation": "What type of performance was done"
},
{
"name": "participant-actor",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItem-participant-actor",
"type": "reference",
"documentation": "Individual who was performing"
},
{
"name": "occurrence",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItem-occurrence",
"type": "date",
"documentation": "When the charged service was applied"
},
{
"name": "entered-date",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItem-entered-date",
"type": "date",
"documentation": "Date the charge item was entered"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItem-patient",
"type": "reference",
"documentation": "Individual service was done for/to"
},
{
"name": "factor-override",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItem-factor-override",
"type": "number",
"documentation": "Factor overriding the associated rules"
},
{
"name": "service",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItem-service",
"type": "reference",
"documentation": "Which rendered service is being charged?"
},
{
"name": "price-override",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItem-price-override",
"type": "quantity",
"documentation": "Price overriding the associated rules"
},
{
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItem-context",
"type": "reference",
"documentation": "Encounter / Episode associated with event"
},
{
"name": "enterer",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItem-enterer",
"type": "reference",
"documentation": "Individual who was entering"
},
{
"name": "account",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItem-account",
"type": "reference",
"documentation": "Account to place this charge"
},
{
"name": "requesting-organization",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItem-requesting-organization",
"type": "reference",
"documentation": "Organization requesting the charged service"
}
]
},
{
"type": "Claim",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Claim"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Claim.care-team",
"Claim.encounter",
"Claim.payee",
"Claim.provider",
"Claim.patient",
"Claim.insurer",
"Claim.organization",
"Claim.enterer",
"Claim.facility"
],
"searchRevInclude": [
"ClaimResponse.request",
"ExplanationOfBenefit.claim"
],
"searchParam": [
{
"name": "care-team",
"definition": "http://hl7.org/fhir/SearchParameter/Claim-care-team",
"type": "reference",
"documentation": "Member of the CareTeam"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Claim-identifier",
"type": "token",
"documentation": "The primary identifier of the financial resource"
},
{
"name": "use",
"definition": "http://hl7.org/fhir/SearchParameter/Claim-use",
"type": "token",
"documentation": "The kind of financial resource"
},
{
"name": "created",
"definition": "http://hl7.org/fhir/SearchParameter/Claim-created",
"type": "date",
"documentation": "The creation date for the Claim"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/Claim-encounter",
"type": "reference",
"documentation": "Encounters associated with a billed line item"
},
{
"name": "priority",
"definition": "http://hl7.org/fhir/SearchParameter/Claim-priority",
"type": "token",
"documentation": "Processing priority requested"
},
{
"name": "payee",
"definition": "http://hl7.org/fhir/SearchParameter/Claim-payee",
"type": "reference",
"documentation": "The party receiving any payment for the Claim"
},
{
"name": "provider",
"definition": "http://hl7.org/fhir/SearchParameter/Claim-provider",
"type": "reference",
"documentation": "Provider responsible for the Claim"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/Claim-patient",
"type": "reference",
"documentation": "Patient receiving the services"
},
{
"name": "insurer",
"definition": "http://hl7.org/fhir/SearchParameter/Claim-insurer",
"type": "reference",
"documentation": "The target payor/insurer for the Claim"
},
{
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/Claim-organization",
"type": "reference",
"documentation": "The reference to the providing organization"
},
{
"name": "enterer",
"definition": "http://hl7.org/fhir/SearchParameter/Claim-enterer",
"type": "reference",
"documentation": "The party responsible for the entry of the Claim"
},
{
"name": "facility",
"definition": "http://hl7.org/fhir/SearchParameter/Claim-facility",
"type": "reference",
"documentation": "Facility responsible for the goods and services"
}
]
},
{
"type": "ClaimResponse",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/ClaimResponse"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"ClaimResponse.request",
"ClaimResponse.insurer",
"ClaimResponse.patient",
"ClaimResponse.request-provider"
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/ClaimResponse-identifier",
"type": "token",
"documentation": "The identity of the claimresponse"
},
{
"name": "request",
"definition": "http://hl7.org/fhir/SearchParameter/ClaimResponse-request",
"type": "reference",
"documentation": "The claim reference"
},
{
"name": "disposition",
"definition": "http://hl7.org/fhir/SearchParameter/ClaimResponse-disposition",
"type": "string",
"documentation": "The contents of the disposition message"
},
{
"name": "insurer",
"definition": "http://hl7.org/fhir/SearchParameter/ClaimResponse-insurer",
"type": "reference",
"documentation": "The organization who generated this resource"
},
{
"name": "created",
"definition": "http://hl7.org/fhir/SearchParameter/ClaimResponse-created",
"type": "date",
"documentation": "The creation date"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/ClaimResponse-patient",
"type": "reference",
"documentation": "The subject of care."
},
{
"name": "payment-date",
"definition": "http://hl7.org/fhir/SearchParameter/ClaimResponse-payment-date",
"type": "date",
"documentation": "The expected paymentDate"
},
{
"name": "request-provider",
"definition": "http://hl7.org/fhir/SearchParameter/ClaimResponse-request-provider",
"type": "reference",
"documentation": "The Provider of the claim"
},
{
"name": "outcome",
"definition": "http://hl7.org/fhir/SearchParameter/ClaimResponse-outcome",
"type": "token",
"documentation": "The processing outcome"
}
]
},
{
"type": "ClinicalImpression",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/ClinicalImpression"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"ClinicalImpression.previous",
"ClinicalImpression.assessor",
"ClinicalImpression.subject",
"ClinicalImpression.finding-ref",
"ClinicalImpression.problem",
"ClinicalImpression.patient",
"ClinicalImpression.context",
"ClinicalImpression.investigation",
"ClinicalImpression.action"
],
"searchRevInclude": [
"ClinicalImpression.previous"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"type": "date",
"documentation": "When the assessment was documented"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/ClinicalImpression-identifier",
"type": "token",
"documentation": "Business identifier"
},
{
"name": "previous",
"definition": "http://hl7.org/fhir/SearchParameter/ClinicalImpression-previous",
"type": "reference",
"documentation": "Reference to last assessment"
},
{
"name": "finding-code",
"definition": "http://hl7.org/fhir/SearchParameter/ClinicalImpression-finding-code",
"type": "token",
"documentation": "What was found"
},
{
"name": "assessor",
"definition": "http://hl7.org/fhir/SearchParameter/ClinicalImpression-assessor",
"type": "reference",
"documentation": "The clinician performing the assessment"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/ClinicalImpression-subject",
"type": "reference",
"documentation": "Patient or group assessed"
},
{
"name": "finding-ref",
"definition": "http://hl7.org/fhir/SearchParameter/ClinicalImpression-finding-ref",
"type": "reference",
"documentation": "What was found"
},
{
"name": "problem",
"definition": "http://hl7.org/fhir/SearchParameter/ClinicalImpression-problem",
"type": "reference",
"documentation": "Relevant impressions of patient state"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Patient or group assessed"
},
{
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/ClinicalImpression-context",
"type": "reference",
"documentation": "Encounter or Episode created from"
},
{
"name": "investigation",
"definition": "http://hl7.org/fhir/SearchParameter/ClinicalImpression-investigation",
"type": "reference",
"documentation": "Record of a specific investigation"
},
{
"name": "action",
"definition": "http://hl7.org/fhir/SearchParameter/ClinicalImpression-action",
"type": "reference",
"documentation": "Action taken as part of assessment procedure"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/ClinicalImpression-status",
"type": "token",
"documentation": "draft | completed | entered-in-error"
}
]
},
{
"type": "CodeSystem",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/CodeSystem"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/CodeSystem-date",
"type": "date",
"documentation": "The code system publication date"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/CodeSystem-identifier",
"type": "token",
"documentation": "External identifier for the code system"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/CodeSystem-code",
"type": "token",
"documentation": "A code defined in the code system"
},
{
"name": "content-mode",
"definition": "http://hl7.org/fhir/SearchParameter/CodeSystem-content-mode",
"type": "token",
"documentation": "not-present | example | fragment | complete"
},
{
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/CodeSystem-jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the code system"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/CodeSystem-description",
"type": "string",
"documentation": "The description of the code system"
},
{
"name": "language",
"definition": "http://hl7.org/fhir/SearchParameter/CodeSystem-language",
"type": "token",
"documentation": "A language in which a designation is provided"
},
{
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/CodeSystem-title",
"type": "string",
"documentation": "The human-friendly name of the code system"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/CodeSystem-version",
"type": "token",
"documentation": "The business version of the code system"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/CodeSystem-url",
"type": "uri",
"documentation": "The uri that identifies the code system"
},
{
"name": "system",
"definition": "http://hl7.org/fhir/SearchParameter/CodeSystem-system",
"type": "uri",
"documentation": "The system for any codes defined by this code system (same as 'url')"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/CodeSystem-name",
"type": "string",
"documentation": "Computationally friendly name of the code system"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/CodeSystem-publisher",
"type": "string",
"documentation": "Name of the publisher of the code system"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/CodeSystem-status",
"type": "token",
"documentation": "The current status of the code system"
}
]
},
{
"type": "Communication",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Communication"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Communication.subject",
"Communication.part-of",
"Communication.encounter",
"Communication.based-on",
"Communication.sender",
"Communication.patient",
"Communication.recipient",
"Communication.context",
"Communication.definition"
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Communication-identifier",
"type": "token",
"documentation": "Unique identifier"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/Communication-subject",
"type": "reference",
"documentation": "Focus of message"
},
{
"name": "received",
"definition": "http://hl7.org/fhir/SearchParameter/Communication-received",
"type": "date",
"documentation": "When received"
},
{
"name": "part-of",
"definition": "http://hl7.org/fhir/SearchParameter/Communication-part-of",
"type": "reference",
"documentation": "Part of this action"
},
{
"name": "medium",
"definition": "http://hl7.org/fhir/SearchParameter/Communication-medium",
"type": "token",
"documentation": "A channel of communication"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/Communication-encounter",
"type": "reference",
"documentation": "Encounter leading to message"
},
{
"name": "sent",
"definition": "http://hl7.org/fhir/SearchParameter/Communication-sent",
"type": "date",
"documentation": "When sent"
},
{
"name": "based-on",
"definition": "http://hl7.org/fhir/SearchParameter/Communication-based-on",
"type": "reference",
"documentation": "Request fulfilled by this communication"
},
{
"name": "sender",
"definition": "http://hl7.org/fhir/SearchParameter/Communication-sender",
"type": "reference",
"documentation": "Message sender"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/Communication-patient",
"type": "reference",
"documentation": "Focus of message"
},
{
"name": "recipient",
"definition": "http://hl7.org/fhir/SearchParameter/Communication-recipient",
"type": "reference",
"documentation": "Message recipient"
},
{
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/Communication-context",
"type": "reference",
"documentation": "Encounter or episode leading to message"
},
{
"name": "definition",
"definition": "http://hl7.org/fhir/SearchParameter/Communication-definition",
"type": "reference",
"documentation": "Instantiates protocol or definition"
},
{
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/Communication-category",
"type": "token",
"documentation": "Message category"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Communication-status",
"type": "token",
"documentation": "preparation | in-progress | suspended | aborted | completed | entered-in-error"
}
]
},
{
"type": "CommunicationRequest",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/CommunicationRequest"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"CommunicationRequest.requester",
"CommunicationRequest.subject",
"CommunicationRequest.replaces",
"CommunicationRequest.encounter",
"CommunicationRequest.based-on",
"CommunicationRequest.sender",
"CommunicationRequest.patient",
"CommunicationRequest.recipient",
"CommunicationRequest.context"
],
"searchRevInclude": [
"CarePlan.activity-reference",
"CommunicationRequest.replaces"
],
"searchParam": [
{
"name": "requester",
"definition": "http://hl7.org/fhir/SearchParameter/CommunicationRequest-requester",
"type": "reference",
"documentation": "Individual making the request"
},
{
"name": "authored",
"definition": "http://hl7.org/fhir/SearchParameter/CommunicationRequest-authored",
"type": "date",
"documentation": "When request transitioned to being actionable"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/CommunicationRequest-identifier",
"type": "token",
"documentation": "Unique identifier"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/CommunicationRequest-subject",
"type": "reference",
"documentation": "Focus of message"
},
{
"name": "replaces",
"definition": "http://hl7.org/fhir/SearchParameter/CommunicationRequest-replaces",
"type": "reference",
"documentation": "Request(s) replaced by this request"
},
{
"name": "medium",
"definition": "http://hl7.org/fhir/SearchParameter/CommunicationRequest-medium",
"type": "token",
"documentation": "A channel of communication"
},
{
"name": "occurrence",
"definition": "http://hl7.org/fhir/SearchParameter/CommunicationRequest-occurrence",
"type": "date",
"documentation": "When scheduled"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/CommunicationRequest-encounter",
"type": "reference",
"documentation": "Encounter leading to message"
},
{
"name": "priority",
"definition": "http://hl7.org/fhir/SearchParameter/CommunicationRequest-priority",
"type": "token",
"documentation": "Message urgency"
},
{
"name": "group-identifier",
"definition": "http://hl7.org/fhir/SearchParameter/CommunicationRequest-group-identifier",
"type": "token",
"documentation": "Composite request this is part of"
},
{
"name": "based-on",
"definition": "http://hl7.org/fhir/SearchParameter/CommunicationRequest-based-on",
"type": "reference",
"documentation": "Fulfills plan or proposal"
},
{
"name": "sender",
"definition": "http://hl7.org/fhir/SearchParameter/CommunicationRequest-sender",
"type": "reference",
"documentation": "Message sender"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/CommunicationRequest-patient",
"type": "reference",
"documentation": "Focus of message"
},
{
"name": "recipient",
"definition": "http://hl7.org/fhir/SearchParameter/CommunicationRequest-recipient",
"type": "reference",
"documentation": "Message recipient"
},
{
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/CommunicationRequest-context",
"type": "reference",
"documentation": "Encounter or episode leading to message"
},
{
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/CommunicationRequest-category",
"type": "token",
"documentation": "Message category"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/CommunicationRequest-status",
"type": "token",
"documentation": "draft | active | suspended | cancelled | completed | entered-in-error | unknown"
}
]
},
{
"type": "CompartmentDefinition",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/CompartmentDefinition"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/CompartmentDefinition-date",
"type": "date",
"documentation": "The compartment definition publication date"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/CompartmentDefinition-code",
"type": "token",
"documentation": "Patient | Encounter | RelatedPerson | Practitioner | Device"
},
{
"name": "resource",
"definition": "http://hl7.org/fhir/SearchParameter/CompartmentDefinition-resource",
"type": "token",
"documentation": "Name of resource type"
},
{
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/CompartmentDefinition-jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the compartment definition"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/CompartmentDefinition-name",
"type": "string",
"documentation": "Computationally friendly name of the compartment definition"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/CompartmentDefinition-description",
"type": "string",
"documentation": "The description of the compartment definition"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/CompartmentDefinition-publisher",
"type": "string",
"documentation": "Name of the publisher of the compartment definition"
},
{
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/CompartmentDefinition-title",
"type": "string",
"documentation": "The human-friendly name of the compartment definition"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/CompartmentDefinition-url",
"type": "uri",
"documentation": "The uri that identifies the compartment definition"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/CompartmentDefinition-status",
"type": "token",
"documentation": "The current status of the compartment definition"
}
]
},
{
"type": "Composition",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Composition"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Composition.subject",
"Composition.author",
"Composition.encounter",
"Composition.attester",
"Composition.entry",
"Composition.related-ref",
"Composition.patient"
],
"searchRevInclude": [
"Composition.related-ref"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"type": "date",
"documentation": "Composition editing time"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "Logical identifier of composition (version-independent)"
},
{
"name": "period",
"definition": "http://hl7.org/fhir/SearchParameter/Composition-period",
"type": "date",
"documentation": "The period covered by the documentation"
},
{
"name": "related-id",
"definition": "http://hl7.org/fhir/SearchParameter/Composition-related-id",
"type": "token",
"documentation": "Target of the relationship"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/Composition-subject",
"type": "reference",
"documentation": "Who and/or what the composition is about"
},
{
"name": "author",
"definition": "http://hl7.org/fhir/SearchParameter/Composition-author",
"type": "reference",
"documentation": "Who and/or what authored the composition"
},
{
"name": "confidentiality",
"definition": "http://hl7.org/fhir/SearchParameter/Composition-confidentiality",
"type": "token",
"documentation": "As defined by affinity domain"
},
{
"name": "section",
"definition": "http://hl7.org/fhir/SearchParameter/Composition-section",
"type": "token",
"documentation": "Classification of section (recommended)"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"type": "reference",
"documentation": "Context of the Composition"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-type",
"type": "token",
"documentation": "Kind of composition (LOINC if possible)"
},
{
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/Composition-title",
"type": "string",
"documentation": "Human Readable name/title"
},
{
"name": "attester",
"definition": "http://hl7.org/fhir/SearchParameter/Composition-attester",
"type": "reference",
"documentation": "Who attested the composition"
},
{
"name": "entry",
"definition": "http://hl7.org/fhir/SearchParameter/Composition-entry",
"type": "reference",
"documentation": "A reference to data that supports this section"
},
{
"name": "related-ref",
"definition": "http://hl7.org/fhir/SearchParameter/Composition-related-ref",
"type": "reference",
"documentation": "Target of the relationship"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Who and/or what the composition is about"
},
{
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/Composition-context",
"type": "token",
"documentation": "Code(s) that apply to the event being documented"
},
{
"name": "class",
"definition": "http://hl7.org/fhir/SearchParameter/Composition-class",
"type": "token",
"documentation": "Categorization of Composition"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Composition-status",
"type": "token",
"documentation": "preliminary | final | amended | entered-in-error"
}
]
},
{
"type": "ConceptMap",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/ConceptMap"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"ConceptMap.source",
"ConceptMap.target",
"ConceptMap.source-uri",
"ConceptMap.target-uri"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-date",
"type": "date",
"documentation": "The concept map publication date"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-identifier",
"type": "token",
"documentation": "External identifier for the concept map"
},
{
"name": "product",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-product",
"type": "uri",
"documentation": "Reference to property mapping depends on"
},
{
"name": "other",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-other",
"type": "uri",
"documentation": "Canonical URL for other concept map"
},
{
"name": "target-system",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-target-system",
"type": "uri",
"documentation": "System of the target (if necessary)"
},
{
"name": "dependson",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-dependson",
"type": "uri",
"documentation": "Reference to property mapping depends on"
},
{
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the concept map"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-description",
"type": "string",
"documentation": "The description of the concept map"
},
{
"name": "source",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-source",
"type": "reference",
"documentation": "Identifies the source of the concepts which are being mapped"
},
{
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-title",
"type": "string",
"documentation": "The human-friendly name of the concept map"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-version",
"type": "token",
"documentation": "The business version of the concept map"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-url",
"type": "uri",
"documentation": "The uri that identifies the concept map"
},
{
"name": "target",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-target",
"type": "reference",
"documentation": "Provides context to the mappings"
},
{
"name": "source-code",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-source-code",
"type": "token",
"documentation": "Identifies element being mapped"
},
{
"name": "source-uri",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-source-uri",
"type": "reference",
"documentation": "Identifies the source of the concepts which are being mapped"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-name",
"type": "string",
"documentation": "Computationally friendly name of the concept map"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-publisher",
"type": "string",
"documentation": "Name of the publisher of the concept map"
},
{
"name": "source-system",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-source-system",
"type": "uri",
"documentation": "Code System (if value set crosses code systems)"
},
{
"name": "target-code",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-target-code",
"type": "token",
"documentation": "Code that identifies the target element"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-status",
"type": "token",
"documentation": "The current status of the concept map"
},
{
"name": "target-uri",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-target-uri",
"type": "reference",
"documentation": "Provides context to the mappings"
}
]
},
{
"type": "Condition",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Condition"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Condition.evidence-detail",
"Condition.subject",
"Condition.encounter",
"Condition.asserter",
"Condition.patient",
"Condition.context"
],
"searchRevInclude": [
"AdverseEvent.reaction",
"CarePlan.condition",
"ClinicalImpression.finding-ref",
"ClinicalImpression.problem",
"Encounter.diagnosis",
"EpisodeOfCare.condition",
"RiskAssessment.condition"
],
"searchParam": [
{
"name": "severity",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-severity",
"type": "token",
"documentation": "The severity of the condition"
},
{
"name": "evidence-detail",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-evidence-detail",
"type": "reference",
"documentation": "Supporting information found elsewhere"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "A unique identifier of the condition record"
},
{
"name": "onset-info",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-onset-info",
"type": "string",
"documentation": "Onsets as a string"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"type": "token",
"documentation": "Code for the condition"
},
{
"name": "evidence",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-evidence",
"type": "token",
"documentation": "Manifestation/symptom"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-subject",
"type": "reference",
"documentation": "Who has the condition?"
},
{
"name": "verification-status",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-verification-status",
"type": "token",
"documentation": "provisional | differential | confirmed | refuted | entered-in-error | unknown"
},
{
"name": "clinical-status",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-clinical-status",
"type": "token",
"documentation": "The clinical status of the condition"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-encounter",
"type": "reference",
"documentation": "Encounter when condition first asserted"
},
{
"name": "abatement-boolean",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-abatement-boolean",
"type": "token",
"documentation": "Abatement boolean (boolean is true or non-boolean values are present)"
},
{
"name": "onset-date",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-onset-date",
"type": "date",
"documentation": "Date related onsets (dateTime and Period)"
},
{
"name": "abatement-date",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-abatement-date",
"type": "date",
"documentation": "Date-related abatements (dateTime and period)"
},
{
"name": "asserter",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-asserter",
"type": "reference",
"documentation": "Person who asserts this condition"
},
{
"name": "stage",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-stage",
"type": "token",
"documentation": "Simple summary (disease specific)"
},
{
"name": "abatement-string",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-abatement-string",
"type": "string",
"documentation": "Abatement as a string"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Who has the condition?"
},
{
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-context",
"type": "reference",
"documentation": "Encounter or episode when condition first asserted"
},
{
"name": "onset-age",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-onset-age",
"type": "quantity",
"documentation": "Onsets as age or age range"
},
{
"name": "abatement-age",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-abatement-age",
"type": "quantity",
"documentation": "Abatement as age or age range"
},
{
"name": "asserted-date",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-asserted-date",
"type": "date",
"documentation": "Date record was believed accurate"
},
{
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-category",
"type": "token",
"documentation": "The category of the condition"
},
{
"name": "body-site",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-body-site",
"type": "token",
"documentation": "Anatomical location, if relevant"
}
]
},
{
"type": "Consent",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Consent"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Consent.data",
"Consent.source",
"Consent.actor",
"Consent.patient",
"Consent.organization",
"Consent.consentor"
],
"searchRevInclude": [
"Consent.source"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"type": "date",
"documentation": "When this Consent was created or indexed"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "Identifier for this record (external references)"
},
{
"name": "securitylabel",
"definition": "http://hl7.org/fhir/SearchParameter/Consent-securitylabel",
"type": "token",
"documentation": "Security Labels that define affected resources"
},
{
"name": "period",
"definition": "http://hl7.org/fhir/SearchParameter/Consent-period",
"type": "date",
"documentation": "Period that this consent applies"
},
{
"name": "data",
"definition": "http://hl7.org/fhir/SearchParameter/Consent-data",
"type": "reference",
"documentation": "The actual data reference"
},
{
"name": "purpose",
"definition": "http://hl7.org/fhir/SearchParameter/Consent-purpose",
"type": "token",
"documentation": "Context of activities for which the agreement is made"
},
{
"name": "source",
"definition": "http://hl7.org/fhir/SearchParameter/Consent-source",
"type": "reference",
"documentation": "Source from which this consent is taken"
},
{
"name": "actor",
"definition": "http://hl7.org/fhir/SearchParameter/Consent-actor",
"type": "reference",
"documentation": "Resource for the actor (or group, by role)"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Who the consent applies to"
},
{
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/Consent-organization",
"type": "reference",
"documentation": "Custodian of the consent"
},
{
"name": "action",
"definition": "http://hl7.org/fhir/SearchParameter/Consent-action",
"type": "token",
"documentation": "Actions controlled by this consent"
},
{
"name": "consentor",
"definition": "http://hl7.org/fhir/SearchParameter/Consent-consentor",
"type": "reference",
"documentation": "Who is agreeing to the policy and exceptions"
},
{
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/Consent-category",
"type": "token",
"documentation": "Classification of the consent statement - for indexing/retrieval"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Consent-status",
"type": "token",
"documentation": "draft | proposed | active | rejected | inactive | entered-in-error"
}
]
},
{
"type": "Contract",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Contract"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Contract.agent",
"Contract.patient",
"Contract.subject",
"Contract.authority",
"Contract.domain",
"Contract.term-topic",
"Contract.signer"
],
"searchRevInclude": [
"Consent.source",
"Contract.agent"
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Contract-identifier",
"type": "token",
"documentation": "The identity of the contract"
},
{
"name": "agent",
"definition": "http://hl7.org/fhir/SearchParameter/Contract-agent",
"type": "reference",
"documentation": "Agent to the Contact"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/Contract-patient",
"type": "reference",
"documentation": "The identity of the subject of the contract (if a patient)"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/Contract-subject",
"type": "reference",
"documentation": "The identity of the subject of the contract"
},
{
"name": "authority",
"definition": "http://hl7.org/fhir/SearchParameter/Contract-authority",
"type": "reference",
"documentation": "The authority of the contract"
},
{
"name": "domain",
"definition": "http://hl7.org/fhir/SearchParameter/Contract-domain",
"type": "reference",
"documentation": "The domain of the contract"
},
{
"name": "term-topic",
"definition": "http://hl7.org/fhir/SearchParameter/Contract-term-topic",
"type": "reference",
"documentation": "The identity of the topic of the contract terms"
},
{
"name": "issued",
"definition": "http://hl7.org/fhir/SearchParameter/Contract-issued",
"type": "date",
"documentation": "The date/time the contract was issued"
},
{
"name": "signer",
"definition": "http://hl7.org/fhir/SearchParameter/Contract-signer",
"type": "reference",
"documentation": "Contract Signatory Party"
}
]
},
{
"type": "Coverage",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Coverage"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Coverage.subscriber",
"Coverage.payor",
"Coverage.beneficiary",
"Coverage.policy-holder"
],
"searchRevInclude": [
"ExplanationOfBenefit.coverage"
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-identifier",
"type": "token",
"documentation": "The primary identifier of the insured and the coverage"
},
{
"name": "subgroup",
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-subgroup",
"type": "string",
"documentation": "Sub-group identifier"
},
{
"name": "subscriber",
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-subscriber",
"type": "reference",
"documentation": "Reference to the subscriber"
},
{
"name": "subplan",
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-subplan",
"type": "string",
"documentation": "Sub-plan identifier"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-type",
"type": "token",
"documentation": "The kind of coverage (health plan, auto, Workers Compensation)"
},
{
"name": "sequence",
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-sequence",
"type": "string",
"documentation": "Sequence number"
},
{
"name": "payor",
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-payor",
"type": "reference",
"documentation": "The identity of the insurer or party paying for services"
},
{
"name": "beneficiary",
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-beneficiary",
"type": "reference",
"documentation": "Covered party"
},
{
"name": "subclass",
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-subclass",
"type": "string",
"documentation": "Sub-class identifier"
},
{
"name": "plan",
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-plan",
"type": "string",
"documentation": "A plan or policy identifier"
},
{
"name": "class",
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-class",
"type": "string",
"documentation": "Class identifier"
},
{
"name": "dependent",
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-dependent",
"type": "string",
"documentation": "Dependent number"
},
{
"name": "group",
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-group",
"type": "string",
"documentation": "Group identifier"
},
{
"name": "policy-holder",
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-policy-holder",
"type": "reference",
"documentation": "Reference to the policyholder"
}
]
},
{
"type": "DataElement",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/DataElement"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/DataElement-date",
"type": "date",
"documentation": "The data element publication date"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/DataElement-identifier",
"type": "token",
"documentation": "External identifier for the data element"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/DataElement-code",
"type": "token",
"documentation": "A code for the data element (server may choose to do subsumption)"
},
{
"name": "stringency",
"definition": "http://hl7.org/fhir/SearchParameter/DataElement-stringency",
"type": "token",
"documentation": "The stringency of the data element definition"
},
{
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/DataElement-jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the data element"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/DataElement-name",
"type": "string",
"documentation": "Computationally friendly name of the data element"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/DataElement-publisher",
"type": "string",
"documentation": "Name of the publisher of the data element"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/DataElement-description",
"type": "string",
"documentation": "Text search in the description of the data element. This corresponds to the definition of the first DataElement.element."
},
{
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/DataElement-title",
"type": "string",
"documentation": "The human-friendly name of the data element"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/DataElement-version",
"type": "token",
"documentation": "The business version of the data element"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/DataElement-url",
"type": "uri",
"documentation": "The uri that identifies the data element"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/DataElement-status",
"type": "token",
"documentation": "The current status of the data element"
}
]
},
{
"type": "DetectedIssue",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/DetectedIssue"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"DetectedIssue.patient",
"DetectedIssue.author",
"DetectedIssue.implicated"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"type": "date",
"documentation": "When identified"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "Unique id for the detected issue"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Associated patient"
},
{
"name": "author",
"definition": "http://hl7.org/fhir/SearchParameter/DetectedIssue-author",
"type": "reference",
"documentation": "The provider or device that identified the issue"
},
{
"name": "implicated",
"definition": "http://hl7.org/fhir/SearchParameter/DetectedIssue-implicated",
"type": "reference",
"documentation": "Problem resource"
},
{
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/DetectedIssue-category",
"type": "token",
"documentation": "Issue Category, e.g. drug-drug, duplicate therapy, etc."
}
]
},
{
"type": "Device",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Device"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Device.patient",
"Device.organization",
"Device.location"
],
"searchRevInclude": [
"Account.subject",
"Account.patient",
"AdverseEvent.subject",
"AdverseEvent.substance",
"Appointment.actor",
"Appointment.practitioner",
"Appointment.patient",
"Appointment.location",
"AppointmentResponse.actor",
"AppointmentResponse.practitioner",
"AppointmentResponse.patient",
"AppointmentResponse.location",
"AuditEvent.agent",
"AuditEvent.patient",
"ChargeItem.participant-actor",
"ChargeItem.enterer",
"Communication.sender",
"Communication.recipient",
"CommunicationRequest.requester",
"CommunicationRequest.sender",
"CommunicationRequest.recipient",
"Composition.author",
"Consent.actor",
"Contract.agent",
"DetectedIssue.author",
"DeviceComponent.source",
"DeviceMetric.source",
"DeviceRequest.requester",
"DeviceRequest.performer",
"DeviceRequest.subject",
"DeviceRequest.patient",
"DeviceRequest.device",
"DeviceUseStatement.device",
"DiagnosticReport.subject",
"DiagnosticReport.patient",
"DocumentManifest.subject",
"DocumentManifest.author",
"DocumentManifest.patient",
"DocumentReference.subject",
"DocumentReference.patient",
"DocumentReference.author",
"Flag.author",
"Group.member",
"ImagingManifest.author",
"List.subject",
"List.patient",
"List.source",
"Media.subject",
"Media.patient",
"Media.device",
"MedicationAdministration.performer",
"MedicationAdministration.device",
"MedicationDispense.performer",
"MedicationRequest.requester",
"MessageHeader.target",
"Observation.subject",
"Observation.patient",
"Observation.device",
"Procedure.performer",
"ProcedureRequest.requester",
"ProcedureRequest.performer",
"ProcedureRequest.subject",
"ProcedureRequest.patient",
"Provenance.agent",
"QuestionnaireResponse.author",
"ReferralRequest.requester",
"RequestGroup.author",
"RiskAssessment.performer",
"Schedule.actor",
"Specimen.subject",
"Specimen.patient",
"SupplyRequest.requester",
"Task.owner",
"Task.requester"
],
"searchParam": [
{
"name": "udi-di",
"definition": "http://hl7.org/fhir/SearchParameter/Device-udi-di",
"type": "string",
"documentation": "The udi Device Identifier (DI)"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Device-identifier",
"type": "token",
"documentation": "Instance id from manufacturer, owner, and others"
},
{
"name": "udi-carrier",
"definition": "http://hl7.org/fhir/SearchParameter/Device-udi-carrier",
"type": "string",
"documentation": "UDI Barcode (RFID or other technology) string either in HRF format or AIDC format converted to base64 string."
},
{
"name": "device-name",
"definition": "http://hl7.org/fhir/SearchParameter/Device-device-name",
"type": "string",
"documentation": "A server defined search that may match any of the string fields in the Device.udi.name or Device.type.coding.display or Device.type.text"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/Device-patient",
"type": "reference",
"documentation": "Patient information, if the resource is affixed to a person"
},
{
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/Device-organization",
"type": "reference",
"documentation": "The organization responsible for the device"
},
{
"name": "model",
"definition": "http://hl7.org/fhir/SearchParameter/Device-model",
"type": "string",
"documentation": "The model of the device"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/Device-location",
"type": "reference",
"documentation": "A location, where the resource is found"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/Device-type",
"type": "token",
"documentation": "The type of the device"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/Device-url",
"type": "uri",
"documentation": "Network address to contact device"
},
{
"name": "manufacturer",
"definition": "http://hl7.org/fhir/SearchParameter/Device-manufacturer",
"type": "string",
"documentation": "The manufacturer of the device"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Device-status",
"type": "token",
"documentation": "active | inactive | entered-in-error | unknown"
}
]
},
{
"type": "DeviceComponent",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/DeviceComponent"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"DeviceComponent.parent",
"DeviceComponent.source"
],
"searchRevInclude": [
"DeviceComponent.parent",
"DeviceMetric.parent"
],
"searchParam": [
{
"name": "parent",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceComponent-parent",
"type": "reference",
"documentation": "The parent DeviceComponent resource"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceComponent-identifier",
"type": "token",
"documentation": "The identifier of the component"
},
{
"name": "source",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceComponent-source",
"type": "reference",
"documentation": "The device source"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceComponent-type",
"type": "token",
"documentation": "The device component type"
}
]
},
{
"type": "DeviceMetric",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/DeviceMetric"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"DeviceMetric.parent",
"DeviceMetric.source"
],
"searchRevInclude": [
"Media.device",
"Observation.device"
],
"searchParam": [
{
"name": "parent",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceMetric-parent",
"type": "reference",
"documentation": "The parent DeviceMetric resource"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceMetric-identifier",
"type": "token",
"documentation": "The identifier of the metric"
},
{
"name": "source",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceMetric-source",
"type": "reference",
"documentation": "The device resource"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceMetric-type",
"type": "token",
"documentation": "The component type"
},
{
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceMetric-category",
"type": "token",
"documentation": "The category of the metric"
}
]
},
{
"type": "DeviceRequest",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/DeviceRequest"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"DeviceRequest.requester",
"DeviceRequest.performer",
"DeviceRequest.subject",
"DeviceRequest.encounter",
"DeviceRequest.based-on",
"DeviceRequest.priorrequest",
"DeviceRequest.patient",
"DeviceRequest.definition",
"DeviceRequest.device"
],
"searchRevInclude": [
"CarePlan.activity-reference",
"Observation.based-on"
],
"searchParam": [
{
"name": "requester",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceRequest-requester",
"type": "reference",
"documentation": "Who/what is requesting service "
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "Business identifier for request/order"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"type": "token",
"documentation": "Code for what is being requested/ordered"
},
{
"name": "performer",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceRequest-performer",
"type": "reference",
"documentation": "Desired performer for service"
},
{
"name": "event-date",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceRequest-event-date",
"type": "date",
"documentation": "When service should occur"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceRequest-subject",
"type": "reference",
"documentation": "Individual the service is ordered for"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"type": "reference",
"documentation": "Encounter or Episode during which request was created"
},
{
"name": "authored-on",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceRequest-authored-on",
"type": "date",
"documentation": "When the request transitioned to being actionable"
},
{
"name": "intent",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceRequest-intent",
"type": "token",
"documentation": "proposal | plan | original-order |reflex-order"
},
{
"name": "group-identifier",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceRequest-group-identifier",
"type": "token",
"documentation": "Composite request this is part of"
},
{
"name": "based-on",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceRequest-based-on",
"type": "reference",
"documentation": "Plan/proposal/order fulfilled by this request"
},
{
"name": "priorrequest",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceRequest-priorrequest",
"type": "reference",
"documentation": "Request takes the place of referenced completed or terminated requests"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Individual the service is ordered for"
},
{
"name": "definition",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceRequest-definition",
"type": "reference",
"documentation": "Protocol or definition followed by this request"
},
{
"name": "device",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceRequest-device",
"type": "reference",
"documentation": "Reference to resource that is being requested/ordered"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceRequest-status",
"type": "token",
"documentation": "entered-in-error | draft | active |suspended | completed "
}
]
},
{
"type": "DeviceUseStatement",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/DeviceUseStatement"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"DeviceUseStatement.subject",
"DeviceUseStatement.patient",
"DeviceUseStatement.device"
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceUseStatement-identifier",
"type": "token",
"documentation": "Search by identifier"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceUseStatement-subject",
"type": "reference",
"documentation": "Search by subject"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Search by subject - a patient"
},
{
"name": "device",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceUseStatement-device",
"type": "reference",
"documentation": "Search by device"
}
]
},
{
"type": "DiagnosticReport",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/DiagnosticReport"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"DiagnosticReport.image",
"DiagnosticReport.performer",
"DiagnosticReport.subject",
"DiagnosticReport.encounter",
"DiagnosticReport.result",
"DiagnosticReport.based-on",
"DiagnosticReport.patient",
"DiagnosticReport.specimen",
"DiagnosticReport.context"
],
"searchRevInclude": [
"ChargeItem.service",
"ClinicalImpression.investigation"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"type": "date",
"documentation": "The clinically relevant time of the report"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "An identifier for the report"
},
{
"name": "image",
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-image",
"type": "reference",
"documentation": "A reference to the image source."
},
{
"name": "performer",
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-performer",
"type": "reference",
"documentation": "Who was the source of the report (organization)"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"type": "token",
"documentation": "The code for the report as a whole, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-subject",
"type": "reference",
"documentation": "The subject of the report"
},
{
"name": "diagnosis",
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-diagnosis",
"type": "token",
"documentation": "A coded diagnosis on the report"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"type": "reference",
"documentation": "The Encounter when the order was made"
},
{
"name": "result",
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-result",
"type": "reference",
"documentation": "Link to an atomic result (observation resource)"
},
{
"name": "based-on",
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-based-on",
"type": "reference",
"documentation": "Reference to the procedure request."
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "The subject of the report if a patient"
},
{
"name": "specimen",
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-specimen",
"type": "reference",
"documentation": "The specimen details"
},
{
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-context",
"type": "reference",
"documentation": "Healthcare event (Episode of Care or Encounter) related to the report"
},
{
"name": "issued",
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-issued",
"type": "date",
"documentation": "When the report was issued"
},
{
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-category",
"type": "token",
"documentation": "Which diagnostic discipline/department created the report"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-status",
"type": "token",
"documentation": "The status of the report"
}
]
},
{
"type": "DocumentManifest",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/DocumentManifest"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"DocumentManifest.content-ref",
"DocumentManifest.subject",
"DocumentManifest.author",
"DocumentManifest.related-ref",
"DocumentManifest.patient",
"DocumentManifest.recipient"
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "Unique Identifier for the set of documents"
},
{
"name": "related-id",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentManifest-related-id",
"type": "token",
"documentation": "Identifiers of things that are related"
},
{
"name": "content-ref",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentManifest-content-ref",
"type": "reference",
"documentation": "Contents of this set of documents"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentManifest-subject",
"type": "reference",
"documentation": "The subject of the set of documents"
},
{
"name": "author",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentManifest-author",
"type": "reference",
"documentation": "Who and/or what authored the manifest"
},
{
"name": "created",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentManifest-created",
"type": "date",
"documentation": "When this document manifest created"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentManifest-description",
"type": "string",
"documentation": "Human-readable description (title)"
},
{
"name": "source",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentManifest-source",
"type": "uri",
"documentation": "The source system/application/software"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-type",
"type": "token",
"documentation": "Kind of document set"
},
{
"name": "related-ref",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentManifest-related-ref",
"type": "reference",
"documentation": "Related Resource"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "The subject of the set of documents"
},
{
"name": "recipient",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentManifest-recipient",
"type": "reference",
"documentation": "Intended to get notified about this set of documents"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentManifest-status",
"type": "token",
"documentation": "current | superseded | entered-in-error"
}
]
},
{
"type": "DocumentReference",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/DocumentReference"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"DocumentReference.subject",
"DocumentReference.patient",
"DocumentReference.authenticator",
"DocumentReference.custodian",
"DocumentReference.author",
"DocumentReference.encounter",
"DocumentReference.related-ref",
"DocumentReference.relatesto"
],
"searchRevInclude": [
"Consent.source",
"DocumentReference.relatesto"
],
"searchParam": [
{
"name": "securitylabel",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-securitylabel",
"type": "token",
"documentation": "Document security-tags"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-subject",
"type": "reference",
"documentation": "Who/what is the subject of the document"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-description",
"type": "string",
"documentation": "Human-readable description (title)"
},
{
"name": "language",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-language",
"type": "token",
"documentation": "Human language of the content (BCP-47)"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-type",
"type": "token",
"documentation": "Kind of document (LOINC if possible)"
},
{
"name": "relation",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-relation",
"type": "token",
"documentation": "replaces | transforms | signs | appends"
},
{
"name": "setting",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-setting",
"type": "token",
"documentation": "Additional details about where the content was created (e.g. clinical specialty)"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Who/what is the subject of the document"
},
{
"name": "relationship",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-relationship",
"type": "composite",
"documentation": "Combination of relation and relatesTo"
},
{
"name": "event",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-event",
"type": "token",
"documentation": "Main clinical acts documented"
},
{
"name": "class",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-class",
"type": "token",
"documentation": "Categorization of document"
},
{
"name": "authenticator",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-authenticator",
"type": "reference",
"documentation": "Who/what authenticated the document"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "Master Version Specific Identifier"
},
{
"name": "period",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-period",
"type": "date",
"documentation": "Time of service that is being documented"
},
{
"name": "related-id",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-related-id",
"type": "token",
"documentation": "Identifier of related objects or events"
},
{
"name": "custodian",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-custodian",
"type": "reference",
"documentation": "Organization which maintains the document"
},
{
"name": "indexed",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-indexed",
"type": "date",
"documentation": "When this document reference was created"
},
{
"name": "author",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-author",
"type": "reference",
"documentation": "Who and/or what authored the document"
},
{
"name": "created",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-created",
"type": "date",
"documentation": "Document creation time"
},
{
"name": "format",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-format",
"type": "token",
"documentation": "Format/content rules for the document"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"type": "reference",
"documentation": "Context of the document content"
},
{
"name": "related-ref",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-related-ref",
"type": "reference",
"documentation": "Related Resource"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-location",
"type": "uri",
"documentation": "Uri where the data can be found"
},
{
"name": "relatesto",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-relatesto",
"type": "reference",
"documentation": "Target of the relationship"
},
{
"name": "facility",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-facility",
"type": "token",
"documentation": "Kind of facility where patient was seen"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-status",
"type": "token",
"documentation": "current | superseded | entered-in-error"
}
]
},
{
"type": "EligibilityRequest",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/EligibilityRequest"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"EligibilityRequest.provider",
"EligibilityRequest.patient",
"EligibilityRequest.organization",
"EligibilityRequest.enterer",
"EligibilityRequest.facility"
],
"searchRevInclude": [
"EligibilityResponse.request"
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/EligibilityRequest-identifier",
"type": "token",
"documentation": "The business identifier of the Eligibility"
},
{
"name": "provider",
"definition": "http://hl7.org/fhir/SearchParameter/EligibilityRequest-provider",
"type": "reference",
"documentation": "The reference to the provider"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/EligibilityRequest-patient",
"type": "reference",
"documentation": "The reference to the patient"
},
{
"name": "created",
"definition": "http://hl7.org/fhir/SearchParameter/EligibilityRequest-created",
"type": "date",
"documentation": "The creation date for the EOB"
},
{
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/EligibilityRequest-organization",
"type": "reference",
"documentation": "The reference to the providing organization"
},
{
"name": "enterer",
"definition": "http://hl7.org/fhir/SearchParameter/EligibilityRequest-enterer",
"type": "reference",
"documentation": "The party who is responsible for the request"
},
{
"name": "facility",
"definition": "http://hl7.org/fhir/SearchParameter/EligibilityRequest-facility",
"type": "reference",
"documentation": "Facility responsible for the goods and services"
}
]
},
{
"type": "EligibilityResponse",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/EligibilityResponse"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"EligibilityResponse.request",
"EligibilityResponse.insurer",
"EligibilityResponse.request-organization",
"EligibilityResponse.request-provider"
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/EligibilityResponse-identifier",
"type": "token",
"documentation": "The business identifier"
},
{
"name": "request",
"definition": "http://hl7.org/fhir/SearchParameter/EligibilityResponse-request",
"type": "reference",
"documentation": "The EligibilityRequest reference"
},
{
"name": "disposition",
"definition": "http://hl7.org/fhir/SearchParameter/EligibilityResponse-disposition",
"type": "string",
"documentation": "The contents of the disposition message"
},
{
"name": "insurer",
"definition": "http://hl7.org/fhir/SearchParameter/EligibilityResponse-insurer",
"type": "reference",
"documentation": "The organization which generated this resource"
},
{
"name": "created",
"definition": "http://hl7.org/fhir/SearchParameter/EligibilityResponse-created",
"type": "date",
"documentation": "The creation date"
},
{
"name": "request-organization",
"definition": "http://hl7.org/fhir/SearchParameter/EligibilityResponse-request-organization",
"type": "reference",
"documentation": "The EligibilityRequest organization"
},
{
"name": "request-provider",
"definition": "http://hl7.org/fhir/SearchParameter/EligibilityResponse-request-provider",
"type": "reference",
"documentation": "The EligibilityRequest provider"
},
{
"name": "outcome",
"definition": "http://hl7.org/fhir/SearchParameter/EligibilityResponse-outcome",
"type": "token",
"documentation": "The processing outcome"
}
]
},
{
"type": "Encounter",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Encounter"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Encounter.episodeofcare",
"Encounter.incomingreferral",
"Encounter.practitioner",
"Encounter.subject",
"Encounter.diagnosis",
"Encounter.appointment",
"Encounter.part-of",
"Encounter.participant",
"Encounter.patient",
"Encounter.location",
"Encounter.service-provider"
],
"searchRevInclude": [
"CarePlan.encounter",
"CarePlan.context",
"CareTeam.context",
"CareTeam.encounter",
"ChargeItem.context",
"Claim.encounter",
"ClinicalImpression.context",
"Communication.encounter",
"Communication.context",
"CommunicationRequest.encounter",
"CommunicationRequest.context",
"Composition.encounter",
"Condition.encounter",
"Condition.context",
"DeviceRequest.encounter",
"DiagnosticReport.encounter",
"DiagnosticReport.context",
"DocumentReference.encounter",
"Encounter.part-of",
"ExplanationOfBenefit.encounter",
"Flag.encounter",
"ImagingStudy.context",
"List.encounter",
"Media.context",
"MedicationAdministration.context",
"MedicationDispense.context",
"MedicationRequest.context",
"MedicationStatement.context",
"NutritionOrder.encounter",
"Observation.context",
"Observation.encounter",
"Procedure.encounter",
"Procedure.context",
"ProcedureRequest.encounter",
"ProcedureRequest.context",
"QuestionnaireResponse.context",
"ReferralRequest.encounter",
"ReferralRequest.context",
"RequestGroup.encounter",
"RequestGroup.context",
"RiskAssessment.encounter",
"Task.context",
"VisionPrescription.encounter"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"type": "date",
"documentation": "A date within the period the Encounter lasted"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "Identifier(s) by which this encounter is known"
},
{
"name": "reason",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-reason",
"type": "token",
"documentation": "Reason the encounter takes place (code)"
},
{
"name": "episodeofcare",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-episodeofcare",
"type": "reference",
"documentation": "Episode(s) of care that this encounter should be recorded against"
},
{
"name": "participant-type",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-participant-type",
"type": "token",
"documentation": "Role of participant in encounter"
},
{
"name": "incomingreferral",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-incomingreferral",
"type": "reference",
"documentation": "The ReferralRequest that initiated this encounter"
},
{
"name": "practitioner",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-practitioner",
"type": "reference",
"documentation": "Persons involved in the encounter other than the patient"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-subject",
"type": "reference",
"documentation": "The patient ro group present at the encounter"
},
{
"name": "length",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-length",
"type": "number",
"documentation": "Length of encounter in days"
},
{
"name": "diagnosis",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-diagnosis",
"type": "reference",
"documentation": "Reason the encounter takes place (resource)"
},
{
"name": "appointment",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-appointment",
"type": "reference",
"documentation": "The appointment that scheduled this encounter"
},
{
"name": "part-of",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-part-of",
"type": "reference",
"documentation": "Another Encounter this encounter is part of"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-type",
"type": "token",
"documentation": "Specific type of encounter"
},
{
"name": "participant",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-participant",
"type": "reference",
"documentation": "Persons involved in the encounter other than the patient"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "The patient ro group present at the encounter"
},
{
"name": "location-period",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-location-period",
"type": "date",
"documentation": "Time period during which the patient was present at the location"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-location",
"type": "reference",
"documentation": "Location the encounter takes place"
},
{
"name": "service-provider",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-service-provider",
"type": "reference",
"documentation": "The custodian organization of this Encounter record"
},
{
"name": "special-arrangement",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-special-arrangement",
"type": "token",
"documentation": "Wheelchair, translator, stretcher, etc."
},
{
"name": "class",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-class",
"type": "token",
"documentation": "inpatient | outpatient | ambulatory | emergency +"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-status",
"type": "token",
"documentation": "planned | arrived | triaged | in-progress | onleave | finished | cancelled +"
}
]
},
{
"type": "Endpoint",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Endpoint"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Endpoint.organization"
],
"searchRevInclude": [
"HealthcareService.endpoint",
"ImagingManifest.endpoint",
"ImagingStudy.endpoint",
"Location.endpoint",
"Organization.endpoint",
"PractitionerRole.endpoint"
],
"searchParam": [
{
"name": "payload-type",
"definition": "http://hl7.org/fhir/SearchParameter/Endpoint-payload-type",
"type": "token",
"documentation": "The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Endpoint-identifier",
"type": "token",
"documentation": "Identifies this endpoint across multiple systems"
},
{
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/Endpoint-organization",
"type": "reference",
"documentation": "The organization that is managing the endpoint"
},
{
"name": "connection-type",
"definition": "http://hl7.org/fhir/SearchParameter/Endpoint-connection-type",
"type": "token",
"documentation": "Protocol/Profile/Standard to be used with this endpoint connection"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/Endpoint-name",
"type": "string",
"documentation": "A name that this endpoint can be identified by"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Endpoint-status",
"type": "token",
"documentation": "The current status of the Endpoint (usually expected to be active)"
}
]
},
{
"type": "EnrollmentRequest",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/EnrollmentRequest"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"EnrollmentRequest.subject",
"EnrollmentRequest.patient",
"EnrollmentRequest.organization"
],
"searchRevInclude": [
"EnrollmentResponse.request"
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/EnrollmentRequest-identifier",
"type": "token",
"documentation": "The business identifier of the Enrollment"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/EnrollmentRequest-subject",
"type": "reference",
"documentation": "The party to be enrolled"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/EnrollmentRequest-patient",
"type": "reference",
"documentation": "The party to be enrolled"
},
{
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/EnrollmentRequest-organization",
"type": "reference",
"documentation": "The organization who generated this resource"
}
]
},
{
"type": "EnrollmentResponse",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/EnrollmentResponse"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"EnrollmentResponse.request",
"EnrollmentResponse.organization"
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/EnrollmentResponse-identifier",
"type": "token",
"documentation": "The business identifier of the EnrollmentResponse"
},
{
"name": "request",
"definition": "http://hl7.org/fhir/SearchParameter/EnrollmentResponse-request",
"type": "reference",
"documentation": "The reference to the claim"
},
{
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/EnrollmentResponse-organization",
"type": "reference",
"documentation": "The organization who generated this resource"
}
]
},
{
"type": "EpisodeOfCare",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"EpisodeOfCare.condition",
"EpisodeOfCare.incomingreferral",
"EpisodeOfCare.patient",
"EpisodeOfCare.organization",
"EpisodeOfCare.care-manager"
],
"searchRevInclude": [
"CarePlan.encounter",
"CarePlan.context",
"CareTeam.context",
"CareTeam.encounter",
"ChargeItem.context",
"ClinicalImpression.context",
"Communication.encounter",
"Communication.context",
"CommunicationRequest.encounter",
"CommunicationRequest.context",
"Condition.encounter",
"Condition.context",
"DeviceRequest.encounter",
"DiagnosticReport.encounter",
"DiagnosticReport.context",
"Encounter.episodeofcare",
"ImagingStudy.context",
"Media.context",
"MedicationAdministration.context",
"MedicationDispense.context",
"MedicationRequest.context",
"MedicationStatement.context",
"Observation.context",
"Observation.encounter",
"Procedure.encounter",
"Procedure.context",
"ProcedureRequest.encounter",
"ProcedureRequest.context",
"QuestionnaireResponse.context",
"ReferralRequest.encounter",
"ReferralRequest.context",
"RequestGroup.encounter",
"RequestGroup.context",
"RiskAssessment.encounter",
"Task.context"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"type": "date",
"documentation": "The provided date search value falls within the episode of care's period"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "Business Identifier(s) relevant for this EpisodeOfCare"
},
{
"name": "condition",
"definition": "http://hl7.org/fhir/SearchParameter/EpisodeOfCare-condition",
"type": "reference",
"documentation": "Conditions/problems/diagnoses this episode of care is for"
},
{
"name": "incomingreferral",
"definition": "http://hl7.org/fhir/SearchParameter/EpisodeOfCare-incomingreferral",
"type": "reference",
"documentation": "Incoming Referral Request"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "The patient who is the focus of this episode of care"
},
{
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/EpisodeOfCare-organization",
"type": "reference",
"documentation": "The organization that has assumed the specific responsibilities of this EpisodeOfCare"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-type",
"type": "token",
"documentation": "Type/class - e.g. specialist referral, disease management"
},
{
"name": "care-manager",
"definition": "http://hl7.org/fhir/SearchParameter/EpisodeOfCare-care-manager",
"type": "reference",
"documentation": "Care manager/care co-ordinator for the patient"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/EpisodeOfCare-status",
"type": "token",
"documentation": "The current status of the Episode of Care as provided (does not check the status history collection)"
}
]
},
{
"type": "ExpansionProfile",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/ExpansionProfile"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/ExpansionProfile-date",
"type": "date",
"documentation": "The expansion profile publication date"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/ExpansionProfile-identifier",
"type": "token",
"documentation": "External identifier for the expansion profile"
},
{
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/ExpansionProfile-jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the expansion profile"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/ExpansionProfile-name",
"type": "string",
"documentation": "Computationally friendly name of the expansion profile"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/ExpansionProfile-description",
"type": "string",
"documentation": "The description of the expansion profile"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/ExpansionProfile-publisher",
"type": "string",
"documentation": "Name of the publisher of the expansion profile"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/ExpansionProfile-version",
"type": "token",
"documentation": "The business version of the expansion profile"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/ExpansionProfile-url",
"type": "uri",
"documentation": "The uri that identifies the expansion profile"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/ExpansionProfile-status",
"type": "token",
"documentation": "The current status of the expansion profile"
}
]
},
{
"type": "ExplanationOfBenefit",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/ExplanationOfBenefit"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"ExplanationOfBenefit.coverage",
"ExplanationOfBenefit.care-team",
"ExplanationOfBenefit.encounter",
"ExplanationOfBenefit.payee",
"ExplanationOfBenefit.provider",
"ExplanationOfBenefit.patient",
"ExplanationOfBenefit.organization",
"ExplanationOfBenefit.claim",
"ExplanationOfBenefit.enterer",
"ExplanationOfBenefit.facility"
],
"searchParam": [
{
"name": "coverage",
"definition": "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-coverage",
"type": "reference",
"documentation": "The plan under which the claim was adjudicated"
},
{
"name": "care-team",
"definition": "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-care-team",
"type": "reference",
"documentation": "Member of the CareTeam"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-identifier",
"type": "token",
"documentation": "The business identifier of the Explanation of Benefit"
},
{
"name": "created",
"definition": "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-created",
"type": "date",
"documentation": "The creation date for the EOB"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-encounter",
"type": "reference",
"documentation": "Encounters associated with a billed line item"
},
{
"name": "payee",
"definition": "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-payee",
"type": "reference",
"documentation": "The party receiving any payment for the Claim"
},
{
"name": "disposition",
"definition": "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-disposition",
"type": "string",
"documentation": "The contents of the disposition message"
},
{
"name": "provider",
"definition": "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-provider",
"type": "reference",
"documentation": "The reference to the provider"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-patient",
"type": "reference",
"documentation": "The reference to the patient"
},
{
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-organization",
"type": "reference",
"documentation": "The reference to the providing organization"
},
{
"name": "claim",
"definition": "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-claim",
"type": "reference",
"documentation": "The reference to the claim"
},
{
"name": "enterer",
"definition": "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-enterer",
"type": "reference",
"documentation": "The party responsible for the entry of the Claim"
},
{
"name": "facility",
"definition": "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-facility",
"type": "reference",
"documentation": "Facility responsible for the goods and services"
}
]
},
{
"type": "FamilyMemberHistory",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"FamilyMemberHistory.patient",
"FamilyMemberHistory.definition"
],
"searchRevInclude": [
"ClinicalImpression.investigation"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"type": "date",
"documentation": "When history was captured/updated"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "A search by a record identifier"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"type": "token",
"documentation": "A search by a condition code"
},
{
"name": "gender",
"definition": "http://hl7.org/fhir/SearchParameter/FamilyMemberHistory-gender",
"type": "token",
"documentation": "A search by a gender code of a family member"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "The identity of a subject to list family member history items for"
},
{
"name": "definition",
"definition": "http://hl7.org/fhir/SearchParameter/FamilyMemberHistory-definition",
"type": "reference",
"documentation": "Instantiates protocol or definition"
},
{
"name": "relationship",
"definition": "http://hl7.org/fhir/SearchParameter/FamilyMemberHistory-relationship",
"type": "token",
"documentation": "A search by a relationship type"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/FamilyMemberHistory-status",
"type": "token",
"documentation": "partial | completed | entered-in-error | health-unknown"
}
]
},
{
"type": "Flag",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Flag"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Flag.subject",
"Flag.patient",
"Flag.author",
"Flag.encounter"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"type": "date",
"documentation": "Time period when flag is active"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Flag-identifier",
"type": "token",
"documentation": "Business identifier"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/Flag-subject",
"type": "reference",
"documentation": "The identity of a subject to list flags for"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "The identity of a subject to list flags for"
},
{
"name": "author",
"definition": "http://hl7.org/fhir/SearchParameter/Flag-author",
"type": "reference",
"documentation": "Flag creator"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"type": "reference",
"documentation": "Alert relevant during encounter"
}
]
},
{
"type": "Goal",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Goal"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Goal.patient",
"Goal.subject"
],
"searchRevInclude": [
"CarePlan.goal"
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "External Ids for this goal"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Who this goal is intended for"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/Goal-subject",
"type": "reference",
"documentation": "Who this goal is intended for"
},
{
"name": "start-date",
"definition": "http://hl7.org/fhir/SearchParameter/Goal-start-date",
"type": "date",
"documentation": "When goal pursuit begins"
},
{
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/Goal-category",
"type": "token",
"documentation": "E.g. Treatment, dietary, behavioral, etc."
},
{
"name": "target-date",
"definition": "http://hl7.org/fhir/SearchParameter/Goal-target-date",
"type": "date",
"documentation": "Reach goal on or before"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Goal-status",
"type": "token",
"documentation": "proposed | accepted | planned | in-progress | on-target | ahead-of-target | behind-target | sustaining | achieved | on-hold | cancelled | entered-in-error | rejected"
}
]
},
{
"type": "GraphDefinition",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/GraphDefinition"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/GraphDefinition-date",
"type": "date",
"documentation": "The graph definition publication date"
},
{
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/GraphDefinition-jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the graph definition"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/GraphDefinition-name",
"type": "string",
"documentation": "Computationally friendly name of the graph definition"
},
{
"name": "start",
"definition": "http://hl7.org/fhir/SearchParameter/GraphDefinition-start",
"type": "token",
"documentation": "Type of resource at which the graph starts"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/GraphDefinition-description",
"type": "string",
"documentation": "The description of the graph definition"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/GraphDefinition-publisher",
"type": "string",
"documentation": "Name of the publisher of the graph definition"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/GraphDefinition-version",
"type": "token",
"documentation": "The business version of the graph definition"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/GraphDefinition-url",
"type": "uri",
"documentation": "The uri that identifies the graph definition"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/GraphDefinition-status",
"type": "token",
"documentation": "The current status of the graph definition"
}
]
},
{
"type": "Group",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Group"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Group.member"
],
"searchRevInclude": [
"CarePlan.subject",
"CarePlan.patient",
"CareTeam.patient",
"CareTeam.subject",
"ChargeItem.subject",
"ChargeItem.patient",
"ClinicalImpression.subject",
"ClinicalImpression.patient",
"Communication.subject",
"Communication.patient",
"Communication.recipient",
"CommunicationRequest.subject",
"CommunicationRequest.patient",
"CommunicationRequest.recipient",
"Condition.subject",
"Condition.patient",
"Consent.actor",
"Contract.agent",
"DeviceRequest.subject",
"DeviceRequest.patient",
"DeviceUseStatement.subject",
"DeviceUseStatement.patient",
"DiagnosticReport.subject",
"DiagnosticReport.patient",
"DocumentManifest.subject",
"DocumentManifest.patient",
"DocumentReference.subject",
"DocumentReference.patient",
"Encounter.subject",
"Encounter.patient",
"Flag.subject",
"Flag.patient",
"Goal.patient",
"Goal.subject",
"GuidanceResponse.patient",
"GuidanceResponse.subject",
"List.subject",
"List.patient",
"Media.subject",
"Media.patient",
"MedicationAdministration.subject",
"MedicationAdministration.patient",
"MedicationDispense.subject",
"MedicationDispense.patient",
"MedicationRequest.subject",
"MedicationRequest.patient",
"MedicationStatement.subject",
"MedicationStatement.patient",
"Observation.subject",
"Observation.patient",
"Procedure.subject",
"Procedure.patient",
"ProcedureRequest.subject",
"ProcedureRequest.patient",
"ReferralRequest.subject",
"ReferralRequest.patient",
"RequestGroup.subject",
"RequestGroup.patient",
"RiskAssessment.subject",
"RiskAssessment.patient",
"Specimen.subject",
"Specimen.patient"
],
"searchParam": [
{
"name": "actual",
"definition": "http://hl7.org/fhir/SearchParameter/Group-actual",
"type": "token",
"documentation": "Descriptive or actual"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Group-identifier",
"type": "token",
"documentation": "Unique id"
},
{
"name": "characteristic-value",
"definition": "http://hl7.org/fhir/SearchParameter/Group-characteristic-value",
"type": "composite",
"documentation": "A composite of both characteristic and value"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/Group-code",
"type": "token",
"documentation": "The kind of resources contained"
},
{
"name": "member",
"definition": "http://hl7.org/fhir/SearchParameter/Group-member",
"type": "reference",
"documentation": "Reference to the group member"
},
{
"name": "exclude",
"definition": "http://hl7.org/fhir/SearchParameter/Group-exclude",
"type": "token",
"documentation": "Group includes or excludes"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/Group-type",
"type": "token",
"documentation": "The type of resources the group contains"
},
{
"name": "value",
"definition": "http://hl7.org/fhir/SearchParameter/Group-value",
"type": "token",
"documentation": "Value held by characteristic"
},
{
"name": "characteristic",
"definition": "http://hl7.org/fhir/SearchParameter/Group-characteristic",
"type": "token",
"documentation": "Kind of characteristic"
}
]
},
{
"type": "GuidanceResponse",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/GuidanceResponse"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"GuidanceResponse.patient",
"GuidanceResponse.subject"
],
"searchParam": [
{
"name": "request",
"definition": "http://hl7.org/fhir/SearchParameter/GuidanceResponse-request",
"type": "token",
"documentation": "The identifier of the request associated with the response"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/GuidanceResponse-identifier",
"type": "token",
"documentation": "The identifier of the guidance response"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/GuidanceResponse-patient",
"type": "reference",
"documentation": "The identity of a patient to search for guidance response results"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/GuidanceResponse-subject",
"type": "reference",
"documentation": "The subject that the guidance response is about"
}
]
},
{
"type": "HealthcareService",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/HealthcareService"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"HealthcareService.endpoint",
"HealthcareService.organization",
"HealthcareService.location"
],
"searchRevInclude": [
"Account.subject",
"Account.patient",
"Appointment.actor",
"Appointment.practitioner",
"Appointment.patient",
"Appointment.location",
"AppointmentResponse.actor",
"AppointmentResponse.practitioner",
"AppointmentResponse.patient",
"AppointmentResponse.location",
"DeviceRequest.performer",
"PractitionerRole.service",
"Procedure.definition",
"ProcedureRequest.performer",
"ReferralRequest.recipient",
"Schedule.actor"
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/HealthcareService-identifier",
"type": "token",
"documentation": "External identifiers for this item"
},
{
"name": "endpoint",
"definition": "http://hl7.org/fhir/SearchParameter/HealthcareService-endpoint",
"type": "reference",
"documentation": "Technical endpoints providing access to services operated for the location"
},
{
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/HealthcareService-organization",
"type": "reference",
"documentation": "The organization that provides this Healthcare Service"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/HealthcareService-name",
"type": "string",
"documentation": "A portion of the Healthcare service name"
},
{
"name": "programname",
"definition": "http://hl7.org/fhir/SearchParameter/HealthcareService-programname",
"type": "string",
"documentation": "One of the Program Names serviced by this HealthcareService"
},
{
"name": "active",
"definition": "http://hl7.org/fhir/SearchParameter/HealthcareService-active",
"type": "token",
"documentation": "The Healthcare Service is currently marked as active"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/HealthcareService-location",
"type": "reference",
"documentation": "The location of the Healthcare Service"
},
{
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/HealthcareService-category",
"type": "token",
"documentation": "Service Category of the Healthcare Service"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/HealthcareService-type",
"type": "token",
"documentation": "The type of service provided by this healthcare service"
},
{
"name": "characteristic",
"definition": "http://hl7.org/fhir/SearchParameter/HealthcareService-characteristic",
"type": "token",
"documentation": "One of the HealthcareService's characteristics"
}
]
},
{
"type": "ImagingManifest",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/ImagingManifest"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"ImagingManifest.endpoint",
"ImagingManifest.author",
"ImagingManifest.patient",
"ImagingManifest.imaging-study"
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/ImagingManifest-identifier",
"type": "token",
"documentation": "UID of the ImagingManifest (or a DICOM Key Object Selection which it represents)"
},
{
"name": "endpoint",
"definition": "http://hl7.org/fhir/SearchParameter/ImagingManifest-endpoint",
"type": "reference",
"documentation": "The endpoint for the study or series"
},
{
"name": "authoring-time",
"definition": "http://hl7.org/fhir/SearchParameter/ImagingManifest-authoring-time",
"type": "date",
"documentation": "Time of the ImagingManifest (or a DICOM Key Object Selection which it represents) authoring"
},
{
"name": "selected-study",
"definition": "http://hl7.org/fhir/SearchParameter/ImagingManifest-selected-study",
"type": "uri",
"documentation": "Study selected in the ImagingManifest (or a DICOM Key Object Selection which it represents)"
},
{
"name": "author",
"definition": "http://hl7.org/fhir/SearchParameter/ImagingManifest-author",
"type": "reference",
"documentation": "Author of the ImagingManifest (or a DICOM Key Object Selection which it represents)"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Subject of the ImagingManifest (or a DICOM Key Object Selection which it represents)"
},
{
"name": "imaging-study",
"definition": "http://hl7.org/fhir/SearchParameter/ImagingManifest-imaging-study",
"type": "reference",
"documentation": "ImagingStudy resource selected in the ImagingManifest (or a DICOM Key Object Selection which it represents)"
}
]
},
{
"type": "ImagingStudy",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/ImagingStudy"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"ImagingStudy.performer",
"ImagingStudy.endpoint",
"ImagingStudy.patient",
"ImagingStudy.context",
"ImagingStudy.basedon"
],
"searchRevInclude": [
"ChargeItem.service",
"ClinicalImpression.investigation",
"ImagingManifest.imaging-study"
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "Other identifiers for the Study"
},
{
"name": "reason",
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-reason",
"type": "token",
"documentation": "The reason for the study"
},
{
"name": "study",
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-study",
"type": "uri",
"documentation": "The study identifier for the image"
},
{
"name": "dicom-class",
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-dicom-class",
"type": "uri",
"documentation": "The type of the instance"
},
{
"name": "modality",
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-modality",
"type": "token",
"documentation": "The modality of the series"
},
{
"name": "bodysite",
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-bodysite",
"type": "token",
"documentation": "The body site studied"
},
{
"name": "performer",
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-performer",
"type": "reference",
"documentation": "The person who performed the study"
},
{
"name": "started",
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-started",
"type": "date",
"documentation": "When the study was started"
},
{
"name": "accession",
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-accession",
"type": "token",
"documentation": "The accession identifier for the study"
},
{
"name": "uid",
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-uid",
"type": "uri",
"documentation": "The instance unique identifier"
},
{
"name": "endpoint",
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-endpoint",
"type": "reference",
"documentation": "The endpoint for te study or series"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Who the study is about"
},
{
"name": "series",
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-series",
"type": "uri",
"documentation": "The identifier of the series of images"
},
{
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-context",
"type": "reference",
"documentation": "The context of the study"
},
{
"name": "basedon",
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-basedon",
"type": "reference",
"documentation": "The order for the image"
}
]
},
{
"type": "Immunization",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Immunization"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Immunization.reaction",
"Immunization.practitioner",
"Immunization.manufacturer",
"Immunization.patient",
"Immunization.location"
],
"searchRevInclude": [
"ChargeItem.service",
"ImmunizationRecommendation.support"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"type": "date",
"documentation": "Vaccination (non)-Administration Date"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "Business identifier"
},
{
"name": "reason",
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-reason",
"type": "token",
"documentation": "Why immunization occurred"
},
{
"name": "reaction",
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-reaction",
"type": "reference",
"documentation": "Additional information on reaction"
},
{
"name": "lot-number",
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-lot-number",
"type": "string",
"documentation": "Vaccine Lot Number"
},
{
"name": "practitioner",
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-practitioner",
"type": "reference",
"documentation": "The practitioner who played a role in the vaccination"
},
{
"name": "notgiven",
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-notgiven",
"type": "token",
"documentation": "Administrations which were not given"
},
{
"name": "manufacturer",
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-manufacturer",
"type": "reference",
"documentation": "Vaccine Manufacturer"
},
{
"name": "dose-sequence",
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-dose-sequence",
"type": "number",
"documentation": "Dose number within series"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "The patient for the vaccination record"
},
{
"name": "vaccine-code",
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-vaccine-code",
"type": "token",
"documentation": "Vaccine Product Administered"
},
{
"name": "reason-not-given",
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-reason-not-given",
"type": "token",
"documentation": "Explanation of reason vaccination was not administered"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-location",
"type": "reference",
"documentation": "The service delivery location or facility in which the vaccine was / was to be administered"
},
{
"name": "reaction-date",
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-reaction-date",
"type": "date",
"documentation": "When reaction started"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-status",
"type": "token",
"documentation": "Immunization event status"
}
]
},
{
"type": "ImmunizationRecommendation",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"ImmunizationRecommendation.patient",
"ImmunizationRecommendation.information",
"ImmunizationRecommendation.support"
],
"searchRevInclude": [
"DiagnosticReport.based-on",
"Observation.based-on"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/ImmunizationRecommendation-date",
"type": "date",
"documentation": "Date recommendation created"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/ImmunizationRecommendation-identifier",
"type": "token",
"documentation": "Business identifier"
},
{
"name": "dose-sequence",
"definition": "http://hl7.org/fhir/SearchParameter/ImmunizationRecommendation-dose-sequence",
"type": "number",
"documentation": "Dose number within sequence"
},
{
"name": "target-disease",
"definition": "http://hl7.org/fhir/SearchParameter/ImmunizationRecommendation-target-disease",
"type": "token",
"documentation": "Disease to be immunized against"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/ImmunizationRecommendation-patient",
"type": "reference",
"documentation": "Who this profile is for"
},
{
"name": "vaccine-type",
"definition": "http://hl7.org/fhir/SearchParameter/ImmunizationRecommendation-vaccine-type",
"type": "token",
"documentation": "Vaccine recommendation applies to"
},
{
"name": "dose-number",
"definition": "http://hl7.org/fhir/SearchParameter/ImmunizationRecommendation-dose-number",
"type": "number",
"documentation": "Recommended dose number"
},
{
"name": "information",
"definition": "http://hl7.org/fhir/SearchParameter/ImmunizationRecommendation-information",
"type": "reference",
"documentation": "Patient observations supporting recommendation"
},
{
"name": "support",
"definition": "http://hl7.org/fhir/SearchParameter/ImmunizationRecommendation-support",
"type": "reference",
"documentation": "Past immunizations supporting recommendation"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/ImmunizationRecommendation-status",
"type": "token",
"documentation": "Vaccine administration status"
}
]
},
{
"type": "ImplementationGuide",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/ImplementationGuide"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"ImplementationGuide.resource"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/ImplementationGuide-date",
"type": "date",
"documentation": "The implementation guide publication date"
},
{
"name": "dependency",
"definition": "http://hl7.org/fhir/SearchParameter/ImplementationGuide-dependency",
"type": "uri",
"documentation": "Where to find dependency"
},
{
"name": "resource",
"definition": "http://hl7.org/fhir/SearchParameter/ImplementationGuide-resource",
"type": "reference",
"documentation": "Location of the resource"
},
{
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/ImplementationGuide-jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the implementation guide"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/ImplementationGuide-name",
"type": "string",
"documentation": "Computationally friendly name of the implementation guide"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/ImplementationGuide-description",
"type": "string",
"documentation": "The description of the implementation guide"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/ImplementationGuide-publisher",
"type": "string",
"documentation": "Name of the publisher of the implementation guide"
},
{
"name": "experimental",
"definition": "http://hl7.org/fhir/SearchParameter/ImplementationGuide-experimental",
"type": "token",
"documentation": "For testing purposes, not real usage"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/ImplementationGuide-version",
"type": "token",
"documentation": "The business version of the implementation guide"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/ImplementationGuide-url",
"type": "uri",
"documentation": "The uri that identifies the implementation guide"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/ImplementationGuide-status",
"type": "token",
"documentation": "The current status of the implementation guide"
}
]
},
{
"type": "Library",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Library"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Library.successor",
"Library.derived-from",
"Library.predecessor",
"Library.composed-of",
"Library.depends-on"
],
"searchRevInclude": [
"ActivityDefinition.depends-on",
"Measure.depends-on",
"PlanDefinition.depends-on"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/Library-date",
"type": "date",
"documentation": "The library publication date"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Library-identifier",
"type": "token",
"documentation": "External identifier for the library"
},
{
"name": "successor",
"definition": "http://hl7.org/fhir/SearchParameter/Library-successor",
"type": "reference",
"documentation": "What resource is being referenced"
},
{
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/Library-jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the library"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/Library-description",
"type": "string",
"documentation": "The description of the library"
},
{
"name": "derived-from",
"definition": "http://hl7.org/fhir/SearchParameter/Library-derived-from",
"type": "reference",
"documentation": "What resource is being referenced"
},
{
"name": "predecessor",
"definition": "http://hl7.org/fhir/SearchParameter/Library-predecessor",
"type": "reference",
"documentation": "What resource is being referenced"
},
{
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/Library-title",
"type": "string",
"documentation": "The human-friendly name of the library"
},
{
"name": "composed-of",
"definition": "http://hl7.org/fhir/SearchParameter/Library-composed-of",
"type": "reference",
"documentation": "What resource is being referenced"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/Library-version",
"type": "token",
"documentation": "The business version of the library"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/Library-url",
"type": "uri",
"documentation": "The uri that identifies the library"
},
{
"name": "effective",
"definition": "http://hl7.org/fhir/SearchParameter/Library-effective",
"type": "date",
"documentation": "The time during which the library is intended to be in use"
},
{
"name": "depends-on",
"definition": "http://hl7.org/fhir/SearchParameter/Library-depends-on",
"type": "reference",
"documentation": "What resource is being referenced"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/Library-name",
"type": "string",
"documentation": "Computationally friendly name of the library"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/Library-publisher",
"type": "string",
"documentation": "Name of the publisher of the library"
},
{
"name": "topic",
"definition": "http://hl7.org/fhir/SearchParameter/Library-topic",
"type": "token",
"documentation": "Topics associated with the module"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Library-status",
"type": "token",
"documentation": "The current status of the library"
}
]
},
{
"type": "Linkage",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Linkage"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Linkage.item",
"Linkage.author",
"Linkage.source"
],
"searchParam": [
{
"name": "item",
"definition": "http://hl7.org/fhir/SearchParameter/Linkage-item",
"type": "reference",
"documentation": "Matches on any item in the Linkage"
},
{
"name": "author",
"definition": "http://hl7.org/fhir/SearchParameter/Linkage-author",
"type": "reference",
"documentation": "Author of the Linkage"
},
{
"name": "source",
"definition": "http://hl7.org/fhir/SearchParameter/Linkage-source",
"type": "reference",
"documentation": "Matches on any item in the Linkage with a type of 'source'"
}
]
},
{
"type": "List",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/List"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"List.item",
"List.subject",
"List.patient",
"List.source",
"List.encounter"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"type": "date",
"documentation": "When the list was prepared"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "Business identifier"
},
{
"name": "item",
"definition": "http://hl7.org/fhir/SearchParameter/List-item",
"type": "reference",
"documentation": "Actual entry"
},
{
"name": "empty-reason",
"definition": "http://hl7.org/fhir/SearchParameter/List-empty-reason",
"type": "token",
"documentation": "Why list is empty"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"type": "token",
"documentation": "What the purpose of this list is"
},
{
"name": "notes",
"definition": "http://hl7.org/fhir/SearchParameter/List-notes",
"type": "string",
"documentation": "The annotation - text content"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/List-subject",
"type": "reference",
"documentation": "If all resources have the same subject"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "If all resources have the same subject"
},
{
"name": "source",
"definition": "http://hl7.org/fhir/SearchParameter/List-source",
"type": "reference",
"documentation": "Who and/or what defined the list contents (aka Author)"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"type": "reference",
"documentation": "Context in which list created"
},
{
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/List-title",
"type": "string",
"documentation": "Descriptive name for the list"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/List-status",
"type": "token",
"documentation": "current | retired | entered-in-error"
}
]
},
{
"type": "Location",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Location"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Location.partof",
"Location.endpoint",
"Location.organization"
],
"searchRevInclude": [
"Account.subject",
"Account.patient",
"AdverseEvent.location",
"Appointment.actor",
"Appointment.practitioner",
"Appointment.patient",
"Appointment.location",
"AppointmentResponse.actor",
"AppointmentResponse.practitioner",
"AppointmentResponse.patient",
"AppointmentResponse.location",
"Claim.facility",
"Contract.agent",
"Contract.domain",
"Device.location",
"DeviceRequest.subject",
"DeviceRequest.patient",
"DiagnosticReport.subject",
"DiagnosticReport.patient",
"EligibilityRequest.facility",
"Encounter.location",
"ExplanationOfBenefit.facility",
"Flag.subject",
"Flag.patient",
"HealthcareService.location",
"Immunization.location",
"List.subject",
"List.patient",
"Location.partof",
"MedicationDispense.destination",
"Observation.subject",
"Observation.patient",
"PractitionerRole.location",
"Procedure.location",
"ProcedureRequest.subject",
"ProcedureRequest.patient",
"Provenance.location",
"ResearchStudy.site",
"Schedule.actor"
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Location-identifier",
"type": "token",
"documentation": "An identifier for the location"
},
{
"name": "partof",
"definition": "http://hl7.org/fhir/SearchParameter/Location-partof",
"type": "reference",
"documentation": "A location of which this location is a part"
},
{
"name": "near-distance",
"definition": "http://hl7.org/fhir/SearchParameter/Location-near-distance",
"type": "quantity",
"documentation": "A distance quantity to limit the near search to locations within a specific distance\n\nRequires the near parameter to also be included"
},
{
"name": "address",
"definition": "http://hl7.org/fhir/SearchParameter/Location-address",
"type": "string",
"documentation": "A (part of the) address of the location"
},
{
"name": "address-state",
"definition": "http://hl7.org/fhir/SearchParameter/Location-address-state",
"type": "string",
"documentation": "A state specified in an address"
},
{
"name": "operational-status",
"definition": "http://hl7.org/fhir/SearchParameter/Location-operational-status",
"type": "token",
"documentation": "Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping)"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/Location-type",
"type": "token",
"documentation": "A code for the type of location"
},
{
"name": "address-postalcode",
"definition": "http://hl7.org/fhir/SearchParameter/Location-address-postalcode",
"type": "string",
"documentation": "A postal code specified in an address"
},
{
"name": "address-country",
"definition": "http://hl7.org/fhir/SearchParameter/Location-address-country",
"type": "string",
"documentation": "A country specified in an address"
},
{
"name": "endpoint",
"definition": "http://hl7.org/fhir/SearchParameter/Location-endpoint",
"type": "reference",
"documentation": "Technical endpoints providing access to services operated for the location"
},
{
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/Location-organization",
"type": "reference",
"documentation": "Searches for locations that are managed by the provided organization"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/Location-name",
"type": "string",
"documentation": "A portion of the location's name or alias"
},
{
"name": "address-use",
"definition": "http://hl7.org/fhir/SearchParameter/Location-address-use",
"type": "token",
"documentation": "A use code specified in an address"
},
{
"name": "near",
"definition": "http://hl7.org/fhir/SearchParameter/Location-near",
"type": "token",
"documentation": "The coordinates expressed as [latitude]:[longitude] (using the WGS84 datum, see notes) to find locations near to (servers may search using a square rather than a circle for efficiency)\n\nRequires the near-distance parameter to be provided also"
},
{
"name": "address-city",
"definition": "http://hl7.org/fhir/SearchParameter/Location-address-city",
"type": "string",
"documentation": "A city specified in an address"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Location-status",
"type": "token",
"documentation": "Searches for locations with a specific kind of status"
}
]
},
{
"type": "Measure",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Measure"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Measure.successor",
"Measure.derived-from",
"Measure.predecessor",
"Measure.composed-of",
"Measure.depends-on"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/Measure-date",
"type": "date",
"documentation": "The measure publication date"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Measure-identifier",
"type": "token",
"documentation": "External identifier for the measure"
},
{
"name": "successor",
"definition": "http://hl7.org/fhir/SearchParameter/Measure-successor",
"type": "reference",
"documentation": "What resource is being referenced"
},
{
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/Measure-jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the measure"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/Measure-description",
"type": "string",
"documentation": "The description of the measure"
},
{
"name": "derived-from",
"definition": "http://hl7.org/fhir/SearchParameter/Measure-derived-from",
"type": "reference",
"documentation": "What resource is being referenced"
},
{
"name": "predecessor",
"definition": "http://hl7.org/fhir/SearchParameter/Measure-predecessor",
"type": "reference",
"documentation": "What resource is being referenced"
},
{
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/Measure-title",
"type": "string",
"documentation": "The human-friendly name of the measure"
},
{
"name": "composed-of",
"definition": "http://hl7.org/fhir/SearchParameter/Measure-composed-of",
"type": "reference",
"documentation": "What resource is being referenced"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/Measure-version",
"type": "token",
"documentation": "The business version of the measure"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/Measure-url",
"type": "uri",
"documentation": "The uri that identifies the measure"
},
{
"name": "effective",
"definition": "http://hl7.org/fhir/SearchParameter/Measure-effective",
"type": "date",
"documentation": "The time during which the measure is intended to be in use"
},
{
"name": "depends-on",
"definition": "http://hl7.org/fhir/SearchParameter/Measure-depends-on",
"type": "reference",
"documentation": "What resource is being referenced"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/Measure-name",
"type": "string",
"documentation": "Computationally friendly name of the measure"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/Measure-publisher",
"type": "string",
"documentation": "Name of the publisher of the measure"
},
{
"name": "topic",
"definition": "http://hl7.org/fhir/SearchParameter/Measure-topic",
"type": "token",
"documentation": "Topics associated with the module"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Measure-status",
"type": "token",
"documentation": "The current status of the measure"
}
]
},
{
"type": "MeasureReport",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/MeasureReport"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"MeasureReport.patient"
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/MeasureReport-identifier",
"type": "token",
"documentation": "External identifier of the measure report to be returned"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/MeasureReport-patient",
"type": "reference",
"documentation": "The identity of a patient to search for individual measure report results for"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/MeasureReport-status",
"type": "token",
"documentation": "The status of the measure report"
}
]
},
{
"type": "Media",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Media"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Media.subject",
"Media.operator",
"Media.based-on",
"Media.patient",
"Media.context",
"Media.device"
],
"searchRevInclude": [
"DiagnosticReport.image"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/Media-date",
"type": "date",
"documentation": "When Media was collected"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Media-identifier",
"type": "token",
"documentation": "Identifier(s) for the image"
},
{
"name": "created",
"definition": "http://hl7.org/fhir/SearchParameter/Media-created",
"type": "date",
"documentation": "Date attachment was first created"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/Media-subject",
"type": "reference",
"documentation": "Who/What this Media is a record of"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/Media-type",
"type": "token",
"documentation": "photo | video | audio"
},
{
"name": "operator",
"definition": "http://hl7.org/fhir/SearchParameter/Media-operator",
"type": "reference",
"documentation": "The person who generated the image"
},
{
"name": "view",
"definition": "http://hl7.org/fhir/SearchParameter/Media-view",
"type": "token",
"documentation": "Imaging view, e.g. Lateral or Antero-posterior"
},
{
"name": "site",
"definition": "http://hl7.org/fhir/SearchParameter/Media-site",
"type": "token",
"documentation": "Body part in media"
},
{
"name": "based-on",
"definition": "http://hl7.org/fhir/SearchParameter/Media-based-on",
"type": "reference",
"documentation": "Procedure that caused this media to be created"
},
{
"name": "subtype",
"definition": "http://hl7.org/fhir/SearchParameter/Media-subtype",
"type": "token",
"documentation": "The type of acquisition equipment/process"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/Media-patient",
"type": "reference",
"documentation": "Who/What this Media is a record of"
},
{
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/Media-context",
"type": "reference",
"documentation": "Encounter / Episode associated with media"
},
{
"name": "device",
"definition": "http://hl7.org/fhir/SearchParameter/Media-device",
"type": "reference",
"documentation": "Observing Device"
}
]
},
{
"type": "Medication",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Medication"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Medication.package-item",
"Medication.ingredient",
"Medication.manufacturer"
],
"searchRevInclude": [
"AdverseEvent.subject",
"AdverseEvent.substance",
"Flag.subject",
"Flag.patient",
"Group.member",
"Medication.package-item",
"Medication.ingredient",
"MedicationAdministration.medication",
"MedicationDispense.medication",
"MedicationRequest.medication",
"MedicationStatement.medication"
],
"searchParam": [
{
"name": "ingredient-code",
"definition": "http://hl7.org/fhir/SearchParameter/Medication-ingredient-code",
"type": "token",
"documentation": "The product contained"
},
{
"name": "container",
"definition": "http://hl7.org/fhir/SearchParameter/Medication-container",
"type": "token",
"documentation": "E.g. box, vial, blister-pack"
},
{
"name": "package-item",
"definition": "http://hl7.org/fhir/SearchParameter/Medication-package-item",
"type": "reference",
"documentation": "The item in the package"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/medications-code",
"type": "token",
"documentation": "Codes that identify this medication"
},
{
"name": "ingredient",
"definition": "http://hl7.org/fhir/SearchParameter/Medication-ingredient",
"type": "reference",
"documentation": "The product contained"
},
{
"name": "form",
"definition": "http://hl7.org/fhir/SearchParameter/Medication-form",
"type": "token",
"documentation": "powder | tablets | capsule +"
},
{
"name": "package-item-code",
"definition": "http://hl7.org/fhir/SearchParameter/Medication-package-item-code",
"type": "token",
"documentation": "The item in the package"
},
{
"name": "manufacturer",
"definition": "http://hl7.org/fhir/SearchParameter/Medication-manufacturer",
"type": "reference",
"documentation": "Manufacturer of the item"
},
{
"name": "over-the-counter",
"definition": "http://hl7.org/fhir/SearchParameter/Medication-over-the-counter",
"type": "token",
"documentation": "True if medication does not require a prescription"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Medication-status",
"type": "token",
"documentation": "active | inactive | entered-in-error"
}
]
},
{
"type": "MedicationAdministration",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/MedicationAdministration"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"MedicationAdministration.performer",
"MedicationAdministration.subject",
"MedicationAdministration.medication",
"MedicationAdministration.prescription",
"MedicationAdministration.patient",
"MedicationAdministration.context",
"MedicationAdministration.device"
],
"searchRevInclude": [
"AdverseEvent.substance",
"ChargeItem.service",
"MedicationStatement.part-of",
"Procedure.part-of"
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/medications-identifier",
"type": "token",
"documentation": "Return administrations with this external identifier"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/medications-code",
"type": "token",
"documentation": "Return administrations of this medication code"
},
{
"name": "performer",
"definition": "http://hl7.org/fhir/SearchParameter/MedicationAdministration-performer",
"type": "reference",
"documentation": "The identify of the individual who administered the medication"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/MedicationAdministration-subject",
"type": "reference",
"documentation": "The identify of the individual or group to list administrations for"
},
{
"name": "not-given",
"definition": "http://hl7.org/fhir/SearchParameter/MedicationAdministration-not-given",
"type": "token",
"documentation": "Administrations that were not made"
},
{
"name": "medication",
"definition": "http://hl7.org/fhir/SearchParameter/medications-medication",
"type": "reference",
"documentation": "Return administrations of this medication resource"
},
{
"name": "reason-given",
"definition": "http://hl7.org/fhir/SearchParameter/MedicationAdministration-reason-given",
"type": "token",
"documentation": "Reasons for administering the medication"
},
{
"name": "prescription",
"definition": "http://hl7.org/fhir/SearchParameter/medications-prescription",
"type": "reference",
"documentation": "The identity of a prescription to list administrations from"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/medications-patient",
"type": "reference",
"documentation": "The identity of a patient to list administrations for"
},
{
"name": "effective-time",
"definition": "http://hl7.org/fhir/SearchParameter/MedicationAdministration-effective-time",
"type": "date",
"documentation": "Date administration happened (or did not happen)"
},
{
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/MedicationAdministration-context",
"type": "reference",
"documentation": "Return administrations that share this encounter or episode of care"
},
{
"name": "reason-not-given",
"definition": "http://hl7.org/fhir/SearchParameter/MedicationAdministration-reason-not-given",
"type": "token",
"documentation": "Reasons for not administering the medication"
},
{
"name": "device",
"definition": "http://hl7.org/fhir/SearchParameter/MedicationAdministration-device",
"type": "reference",
"documentation": "Return administrations with this administration device identity"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/medications-status",
"type": "token",
"documentation": "MedicationAdministration event status (for example one of active/paused/completed/nullified)"
}
]
},
{
"type": "MedicationDispense",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/MedicationDispense"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"MedicationDispense.performer",
"MedicationDispense.receiver",
"MedicationDispense.subject",
"MedicationDispense.destination",
"MedicationDispense.medication",
"MedicationDispense.responsibleparty",
"MedicationDispense.prescription",
"MedicationDispense.patient",
"MedicationDispense.context"
],
"searchRevInclude": [
"ChargeItem.service",
"MedicationStatement.part-of"
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/medications-identifier",
"type": "token",
"documentation": "Return dispenses with this external identifier"
},
{
"name": "performer",
"definition": "http://hl7.org/fhir/SearchParameter/MedicationDispense-performer",
"type": "reference",
"documentation": "Return dispenses performed by a specific individual"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/medications-code",
"type": "token",
"documentation": "Return dispenses of this medicine code"
},
{
"name": "receiver",
"definition": "http://hl7.org/fhir/SearchParameter/MedicationDispense-receiver",
"type": "reference",
"documentation": "The identity of a receiver to list dispenses for"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/MedicationDispense-subject",
"type": "reference",
"documentation": "The identity of a patient to list dispenses for"
},
{
"name": "destination",
"definition": "http://hl7.org/fhir/SearchParameter/MedicationDispense-destination",
"type": "reference",
"documentation": "Return dispenses that should be sent to a specific destination"
},
{
"name": "medication",
"definition": "http://hl7.org/fhir/SearchParameter/medications-medication",
"type": "reference",
"documentation": "Return dispenses of this medicine resource"
},
{
"name": "responsibleparty",
"definition": "http://hl7.org/fhir/SearchParameter/MedicationDispense-responsibleparty",
"type": "reference",
"documentation": "Return dispenses with the specified responsible party"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/MedicationDispense-type",
"type": "token",
"documentation": "Return dispenses of a specific type"
},
{
"name": "whenhandedover",
"definition": "http://hl7.org/fhir/SearchParameter/MedicationDispense-whenhandedover",
"type": "date",
"documentation": "Returns dispenses handed over on this date"
},
{
"name": "whenprepared",
"definition": "http://hl7.org/fhir/SearchParameter/MedicationDispense-whenprepared",
"type": "date",
"documentation": "Returns dispenses prepared on this date"
},
{
"name": "prescription",
"definition": "http://hl7.org/fhir/SearchParameter/medications-prescription",
"type": "reference",
"documentation": "The identity of a prescription to list dispenses from"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/medications-patient",
"type": "reference",
"documentation": "The identity of a patient to list dispenses for"
},
{
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/MedicationDispense-context",
"type": "reference",
"documentation": "Returns dispenses with a specific context (episode or episode of care)"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/medications-status",
"type": "token",
"documentation": "Return dispenses with a specified dispense status"
}
]
},
{
"type": "MedicationRequest",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/MedicationRequest"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"MedicationRequest.requester",
"MedicationRequest.intended-dispenser",
"MedicationRequest.subject",
"MedicationRequest.medication",
"MedicationRequest.patient",
"MedicationRequest.context"
],
"searchRevInclude": [
"CarePlan.activity-reference",
"ClinicalImpression.action",
"DiagnosticReport.based-on",
"MedicationAdministration.prescription",
"MedicationDispense.prescription",
"Observation.based-on"
],
"searchParam": [
{
"name": "requester",
"definition": "http://hl7.org/fhir/SearchParameter/MedicationRequest-requester",
"type": "reference",
"documentation": "Returns prescriptions prescribed by this prescriber"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/medications-date",
"type": "date",
"documentation": "Returns medication request to be administered on a specific date"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/medications-identifier",
"type": "token",
"documentation": "Return prescriptions with this external identifier"
},
{
"name": "intended-dispenser",
"definition": "http://hl7.org/fhir/SearchParameter/MedicationRequest-intended-dispenser",
"type": "reference",
"documentation": "Returns prescriptions intended to be dispensed by this Organization"
},
{
"name": "authoredon",
"definition": "http://hl7.org/fhir/SearchParameter/MedicationRequest-authoredon",
"type": "date",
"documentation": "Return prescriptions written on this date"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/medications-code",
"type": "token",
"documentation": "Return prescriptions of this medication code"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/MedicationRequest-subject",
"type": "reference",
"documentation": "The identity of a patient to list orders for"
},
{
"name": "medication",
"definition": "http://hl7.org/fhir/SearchParameter/medications-medication",
"type": "reference",
"documentation": "Return prescriptions of this medication reference"
},
{
"name": "priority",
"definition": "http://hl7.org/fhir/SearchParameter/MedicationRequest-priority",
"type": "token",
"documentation": "Returns prescriptions with different priorities"
},
{
"name": "intent",
"definition": "http://hl7.org/fhir/SearchParameter/MedicationRequest-intent",
"type": "token",
"documentation": "Returns prescriptions with different intents"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/medications-patient",
"type": "reference",
"documentation": "Returns prescriptions for a specific patient"
},
{
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/MedicationRequest-context",
"type": "reference",
"documentation": "Return prescriptions with this encounter or episode of care identifier"
},
{
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/MedicationRequest-category",
"type": "token",
"documentation": "Returns prescriptions with different categories"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/medications-status",
"type": "token",
"documentation": "Status of the prescription"
}
]
},
{
"type": "MedicationStatement",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/MedicationStatement"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"MedicationStatement.subject",
"MedicationStatement.patient",
"MedicationStatement.context",
"MedicationStatement.medication",
"MedicationStatement.part-of",
"MedicationStatement.source"
],
"searchRevInclude": [
"AdverseEvent.substance",
"MedicationStatement.part-of"
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/medications-identifier",
"type": "token",
"documentation": "Return statements with this external identifier"
},
{
"name": "effective",
"definition": "http://hl7.org/fhir/SearchParameter/MedicationStatement-effective",
"type": "date",
"documentation": "Date when patient was taking (or not taking) the medication"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/medications-code",
"type": "token",
"documentation": "Return statements of this medication code"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/MedicationStatement-subject",
"type": "reference",
"documentation": "The identity of a patient, animal or group to list statements for"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/medications-patient",
"type": "reference",
"documentation": "Returns statements for a specific patient."
},
{
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/MedicationStatement-context",
"type": "reference",
"documentation": "Returns statements for a specific context (episode or episode of Care)."
},
{
"name": "medication",
"definition": "http://hl7.org/fhir/SearchParameter/medications-medication",
"type": "reference",
"documentation": "Return statements of this medication reference"
},
{
"name": "part-of",
"definition": "http://hl7.org/fhir/SearchParameter/MedicationStatement-part-of",
"type": "reference",
"documentation": "Returns statements that are part of another event."
},
{
"name": "source",
"definition": "http://hl7.org/fhir/SearchParameter/MedicationStatement-source",
"type": "reference",
"documentation": "Who or where the information in the statement came from"
},
{
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/MedicationStatement-category",
"type": "token",
"documentation": "Returns statements of this category of medicationstatement"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/medications-status",
"type": "token",
"documentation": "Return statements that match the given status"
}
]
},
{
"type": "MessageDefinition",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/MessageDefinition"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/MessageDefinition-date",
"type": "date",
"documentation": "The message definition publication date"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/MessageDefinition-identifier",
"type": "token",
"documentation": "External identifier for the message definition"
},
{
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/MessageDefinition-jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the message definition"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/MessageDefinition-description",
"type": "string",
"documentation": "The description of the message definition"
},
{
"name": "focus",
"definition": "http://hl7.org/fhir/SearchParameter/MessageDefinition-focus",
"type": "token",
"documentation": "A resource that is a permitted focus of the message"
},
{
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/MessageDefinition-title",
"type": "string",
"documentation": "The human-friendly name of the message definition"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/MessageDefinition-version",
"type": "token",
"documentation": "The business version of the message definition"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/MessageDefinition-url",
"type": "uri",
"documentation": "The uri that identifies the message definition"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/MessageDefinition-name",
"type": "string",
"documentation": "Computationally friendly name of the message definition"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/MessageDefinition-publisher",
"type": "string",
"documentation": "Name of the publisher of the message definition"
},
{
"name": "event",
"definition": "http://hl7.org/fhir/SearchParameter/MessageDefinition-event",
"type": "token",
"documentation": "The event that triggers the message"
},
{
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/MessageDefinition-category",
"type": "token",
"documentation": "The behavior associated with the message"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/MessageDefinition-status",
"type": "token",
"documentation": "The current status of the message definition"
}
]
},
{
"type": "MessageHeader",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/MessageHeader"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"MessageHeader.receiver",
"MessageHeader.author",
"MessageHeader.focus",
"MessageHeader.target",
"MessageHeader.sender",
"MessageHeader.responsible",
"MessageHeader.enterer"
],
"searchParam": [
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/MessageHeader-code",
"type": "token",
"documentation": "ok | transient-error | fatal-error"
},
{
"name": "receiver",
"definition": "http://hl7.org/fhir/SearchParameter/MessageHeader-receiver",
"type": "reference",
"documentation": "Intended \"real-world\" recipient for the data"
},
{
"name": "author",
"definition": "http://hl7.org/fhir/SearchParameter/MessageHeader-author",
"type": "reference",
"documentation": "The source of the decision"
},
{
"name": "destination",
"definition": "http://hl7.org/fhir/SearchParameter/MessageHeader-destination",
"type": "string",
"documentation": "Name of system"
},
{
"name": "focus",
"definition": "http://hl7.org/fhir/SearchParameter/MessageHeader-focus",
"type": "reference",
"documentation": "The actual content of the message"
},
{
"name": "source",
"definition": "http://hl7.org/fhir/SearchParameter/MessageHeader-source",
"type": "string",
"documentation": "Name of system"
},
{
"name": "target",
"definition": "http://hl7.org/fhir/SearchParameter/MessageHeader-target",
"type": "reference",
"documentation": "Particular delivery destination within the destination"
},
{
"name": "destination-uri",
"definition": "http://hl7.org/fhir/SearchParameter/MessageHeader-destination-uri",
"type": "uri",
"documentation": "Actual destination address or id"
},
{
"name": "source-uri",
"definition": "http://hl7.org/fhir/SearchParameter/MessageHeader-source-uri",
"type": "uri",
"documentation": "Actual message source address or id"
},
{
"name": "sender",
"definition": "http://hl7.org/fhir/SearchParameter/MessageHeader-sender",
"type": "reference",
"documentation": "Real world sender of the message"
},
{
"name": "responsible",
"definition": "http://hl7.org/fhir/SearchParameter/MessageHeader-responsible",
"type": "reference",
"documentation": "Final responsibility for event"
},
{
"name": "enterer",
"definition": "http://hl7.org/fhir/SearchParameter/MessageHeader-enterer",
"type": "reference",
"documentation": "The source of the data entry"
},
{
"name": "response-id",
"definition": "http://hl7.org/fhir/SearchParameter/MessageHeader-response-id",
"type": "token",
"documentation": "Id of original message"
},
{
"name": "event",
"definition": "http://hl7.org/fhir/SearchParameter/MessageHeader-event",
"type": "token",
"documentation": "Code for the event this message represents"
},
{
"name": "timestamp",
"definition": "http://hl7.org/fhir/SearchParameter/MessageHeader-timestamp",
"type": "date",
"documentation": "Time that the message was sent"
}
]
},
{
"type": "NamingSystem",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/NamingSystem"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"NamingSystem.replaced-by"
],
"searchRevInclude": [
"NamingSystem.replaced-by"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/NamingSystem-date",
"type": "date",
"documentation": "The naming system publication date"
},
{
"name": "period",
"definition": "http://hl7.org/fhir/SearchParameter/NamingSystem-period",
"type": "date",
"documentation": "When is identifier valid?"
},
{
"name": "kind",
"definition": "http://hl7.org/fhir/SearchParameter/NamingSystem-kind",
"type": "token",
"documentation": "codesystem | identifier | root"
},
{
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/NamingSystem-jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the naming system"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/NamingSystem-description",
"type": "string",
"documentation": "The description of the naming system"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/NamingSystem-type",
"type": "token",
"documentation": "e.g. driver, provider, patient, bank etc."
},
{
"name": "id-type",
"definition": "http://hl7.org/fhir/SearchParameter/NamingSystem-id-type",
"type": "token",
"documentation": "oid | uuid | uri | other"
},
{
"name": "responsible",
"definition": "http://hl7.org/fhir/SearchParameter/NamingSystem-responsible",
"type": "string",
"documentation": "Who maintains system namespace?"
},
{
"name": "contact",
"definition": "http://hl7.org/fhir/SearchParameter/NamingSystem-contact",
"type": "string",
"documentation": "Name of an individual to contact"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/NamingSystem-name",
"type": "string",
"documentation": "Computationally friendly name of the naming system"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/NamingSystem-publisher",
"type": "string",
"documentation": "Name of the publisher of the naming system"
},
{
"name": "telecom",
"definition": "http://hl7.org/fhir/SearchParameter/NamingSystem-telecom",
"type": "token",
"documentation": "Contact details for individual or organization"
},
{
"name": "value",
"definition": "http://hl7.org/fhir/SearchParameter/NamingSystem-value",
"type": "string",
"documentation": "The unique identifier"
},
{
"name": "replaced-by",
"definition": "http://hl7.org/fhir/SearchParameter/NamingSystem-replaced-by",
"type": "reference",
"documentation": "Use this instead"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/NamingSystem-status",
"type": "token",
"documentation": "The current status of the naming system"
}
]
},
{
"type": "NutritionOrder",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/NutritionOrder"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"NutritionOrder.provider",
"NutritionOrder.patient",
"NutritionOrder.encounter"
],
"searchRevInclude": [
"CarePlan.activity-reference",
"DiagnosticReport.based-on",
"Observation.based-on"
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "Return nutrition orders with this external identifier"
},
{
"name": "datetime",
"definition": "http://hl7.org/fhir/SearchParameter/NutritionOrder-datetime",
"type": "date",
"documentation": "Return nutrition orders requested on this date"
},
{
"name": "provider",
"definition": "http://hl7.org/fhir/SearchParameter/NutritionOrder-provider",
"type": "reference",
"documentation": "The identify of the provider who placed the nutrition order"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "The identity of the person who requires the diet, formula or nutritional supplement"
},
{
"name": "supplement",
"definition": "http://hl7.org/fhir/SearchParameter/NutritionOrder-supplement",
"type": "token",
"documentation": "Type of supplement product requested"
},
{
"name": "formula",
"definition": "http://hl7.org/fhir/SearchParameter/NutritionOrder-formula",
"type": "token",
"documentation": "Type of enteral or infant formula"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"type": "reference",
"documentation": "Return nutrition orders with this encounter identifier"
},
{
"name": "oraldiet",
"definition": "http://hl7.org/fhir/SearchParameter/NutritionOrder-oraldiet",
"type": "token",
"documentation": "Type of diet that can be consumed orally (i.e., take via the mouth)."
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/NutritionOrder-status",
"type": "token",
"documentation": "Status of the nutrition order."
},
{
"name": "additive",
"definition": "http://hl7.org/fhir/SearchParameter/NutritionOrder-additive",
"type": "token",
"documentation": "Type of module component to add to the feeding"
}
]
},
{
"type": "Observation",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Observation"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Observation.subject",
"Observation.based-on",
"Observation.patient",
"Observation.specimen",
"Observation.context",
"Observation.performer",
"Observation.encounter",
"Observation.related-target",
"Observation.device"
],
"searchRevInclude": [
"ChargeItem.service",
"ClinicalImpression.finding-ref",
"ClinicalImpression.investigation",
"DiagnosticReport.result",
"Immunization.reaction",
"ImmunizationRecommendation.information",
"MedicationStatement.part-of",
"Observation.related-target",
"Procedure.part-of",
"QuestionnaireResponse.parent"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"type": "date",
"documentation": "Obtained date/time. If the obtained element is a period, a date that falls in the period"
},
{
"name": "combo-data-absent-reason",
"definition": "http://hl7.org/fhir/SearchParameter/Observation-combo-data-absent-reason",
"type": "token",
"documentation": "The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing."
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"type": "token",
"documentation": "The code of the observation type"
},
{
"name": "combo-code-value-quantity",
"definition": "http://hl7.org/fhir/SearchParameter/Observation-combo-code-value-quantity",
"type": "composite",
"documentation": "Code and quantity value parameter pair, including in components"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/Observation-subject",
"type": "reference",
"documentation": "The subject that the observation is about"
},
{
"name": "component-data-absent-reason",
"definition": "http://hl7.org/fhir/SearchParameter/Observation-component-data-absent-reason",
"type": "token",
"documentation": "The reason why the expected value in the element Observation.component.value[x] is missing."
},
{
"name": "value-concept",
"definition": "http://hl7.org/fhir/SearchParameter/Observation-value-concept",
"type": "token",
"documentation": "The value of the observation, if the value is a CodeableConcept"
},
{
"name": "value-date",
"definition": "http://hl7.org/fhir/SearchParameter/Observation-value-date",
"type": "date",
"documentation": "The value of the observation, if the value is a date or period of time"
},
{
"name": "code-value-string",
"definition": "http://hl7.org/fhir/SearchParameter/Observation-code-value-string",
"type": "composite",
"documentation": "Code and string value parameter pair"
},
{
"name": "component-code-value-quantity",
"definition": "http://hl7.org/fhir/SearchParameter/Observation-component-code-value-quantity",
"type": "composite",
"documentation": "Component code and component quantity value parameter pair"
},
{
"name": "based-on",
"definition": "http://hl7.org/fhir/SearchParameter/Observation-based-on",
"type": "reference",
"documentation": "Reference to the test or procedure request."
},
{
"name": "related",
"definition": "http://hl7.org/fhir/SearchParameter/Observation-related",
"type": "composite",
"documentation": "Related Observations - search on related-type and related-target together"
},
{
"name": "code-value-date",
"definition": "http://hl7.org/fhir/SearchParameter/Observation-code-value-date",
"type": "composite",
"documentation": "Code and date/time value parameter pair"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "The subject that the observation is about (if patient)"
},
{
"name": "specimen",
"definition": "http://hl7.org/fhir/SearchParameter/Observation-specimen",
"type": "reference",
"documentation": "Specimen used for this observation"
},
{
"name": "component-code",
"definition": "http://hl7.org/fhir/SearchParameter/Observation-component-code",
"type": "token",
"documentation": "The component code of the observation type"
},
{
"name": "code-value-quantity",
"definition": "http://hl7.org/fhir/SearchParameter/Observation-code-value-quantity",
"type": "composite",
"documentation": "Code and quantity value parameter pair"
},
{
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/Observation-context",
"type": "reference",
"documentation": "Healthcare event (Episode-of-care or Encounter) related to the observation"
},
{
"name": "combo-code-value-concept",
"definition": "http://hl7.org/fhir/SearchParameter/Observation-combo-code-value-concept",
"type": "composite",
"documentation": "Code and coded value parameter pair, including in components"
},
{
"name": "value-string",
"definition": "http://hl7.org/fhir/SearchParameter/Observation-value-string",
"type": "string",
"documentation": "The value of the observation, if the value is a string, and also searches in CodeableConcept.text"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "The unique id for a particular observation"
},
{
"name": "performer",
"definition": "http://hl7.org/fhir/SearchParameter/Observation-performer",
"type": "reference",
"documentation": "Who performed the observation"
},
{
"name": "combo-code",
"definition": "http://hl7.org/fhir/SearchParameter/Observation-combo-code",
"type": "token",
"documentation": "The code of the observation type or component type"
},
{
"name": "method",
"definition": "http://hl7.org/fhir/SearchParameter/Observation-method",
"type": "token",
"documentation": "The method used for the observation"
},
{
"name": "value-quantity",
"definition": "http://hl7.org/fhir/SearchParameter/Observation-value-quantity",
"type": "quantity",
"documentation": "The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)"
},
{
"name": "component-value-quantity",
"definition": "http://hl7.org/fhir/SearchParameter/Observation-component-value-quantity",
"type": "quantity",
"documentation": "The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)"
},
{
"name": "data-absent-reason",
"definition": "http://hl7.org/fhir/SearchParameter/Observation-data-absent-reason",
"type": "token",
"documentation": "The reason why the expected value in the element Observation.value[x] is missing."
},
{
"name": "combo-value-quantity",
"definition": "http://hl7.org/fhir/SearchParameter/Observation-combo-value-quantity",
"type": "quantity",
"documentation": "The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"type": "reference",
"documentation": "Encounter related to the observation"
},
{
"name": "related-type",
"definition": "http://hl7.org/fhir/SearchParameter/Observation-related-type",
"type": "token",
"documentation": "has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by"
},
{
"name": "related-target",
"definition": "http://hl7.org/fhir/SearchParameter/Observation-related-target",
"type": "reference",
"documentation": "Resource that is related to this one"
},
{
"name": "code-value-concept",
"definition": "http://hl7.org/fhir/SearchParameter/Observation-code-value-concept",
"type": "composite",
"documentation": "Code and coded value parameter pair"
},
{
"name": "component-code-value-concept",
"definition": "http://hl7.org/fhir/SearchParameter/Observation-component-code-value-concept",
"type": "composite",
"documentation": "Component code and component coded value parameter pair"
},
{
"name": "component-value-concept",
"definition": "http://hl7.org/fhir/SearchParameter/Observation-component-value-concept",
"type": "token",
"documentation": "The value of the component observation, if the value is a CodeableConcept"
},
{
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/Observation-category",
"type": "token",
"documentation": "The classification of the type of observation"
},
{
"name": "device",
"definition": "http://hl7.org/fhir/SearchParameter/Observation-device",
"type": "reference",
"documentation": "The Device that generated the observation data."
},
{
"name": "combo-value-concept",
"definition": "http://hl7.org/fhir/SearchParameter/Observation-combo-value-concept",
"type": "token",
"documentation": "The value or component value of the observation, if the value is a CodeableConcept"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Observation-status",
"type": "token",
"documentation": "The status of the observation"
}
]
},
{
"type": "OperationDefinition",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/OperationDefinition"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"OperationDefinition.param-profile",
"OperationDefinition.base"
],
"searchRevInclude": [
"OperationDefinition.base"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/OperationDefinition-date",
"type": "date",
"documentation": "The operation definition publication date"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/OperationDefinition-code",
"type": "token",
"documentation": "Name used to invoke the operation"
},
{
"name": "instance",
"definition": "http://hl7.org/fhir/SearchParameter/OperationDefinition-instance",
"type": "token",
"documentation": "Invoke on an instance?"
},
{
"name": "kind",
"definition": "http://hl7.org/fhir/SearchParameter/OperationDefinition-kind",
"type": "token",
"documentation": "operation | query"
},
{
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/OperationDefinition-jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the operation definition"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/OperationDefinition-description",
"type": "string",
"documentation": "The description of the operation definition"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/OperationDefinition-type",
"type": "token",
"documentation": "Invole at the type level?"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/OperationDefinition-version",
"type": "token",
"documentation": "The business version of the operation definition"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/OperationDefinition-url",
"type": "uri",
"documentation": "The uri that identifies the operation definition"
},
{
"name": "system",
"definition": "http://hl7.org/fhir/SearchParameter/OperationDefinition-system",
"type": "token",
"documentation": "Invoke at the system level?"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/OperationDefinition-name",
"type": "string",
"documentation": "Computationally friendly name of the operation definition"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/OperationDefinition-publisher",
"type": "string",
"documentation": "Name of the publisher of the operation definition"
},
{
"name": "param-profile",
"definition": "http://hl7.org/fhir/SearchParameter/OperationDefinition-param-profile",
"type": "reference",
"documentation": "Profile on the type"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/OperationDefinition-status",
"type": "token",
"documentation": "The current status of the operation definition"
},
{
"name": "base",
"definition": "http://hl7.org/fhir/SearchParameter/OperationDefinition-base",
"type": "reference",
"documentation": "Marks this as a profile of the base"
}
]
},
{
"type": "OperationOutcome",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/OperationOutcome"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
]
},
{
"type": "Organization",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Organization"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Organization.partof",
"Organization.endpoint"
],
"searchRevInclude": [
"Account.owner",
"Account.subject",
"Account.patient",
"AuditEvent.agent",
"AuditEvent.patient",
"CarePlan.performer",
"CareTeam.participant",
"ChargeItem.performing-organization",
"ChargeItem.participant-actor",
"ChargeItem.enterer",
"ChargeItem.requesting-organization",
"Claim.care-team",
"Claim.payee",
"Claim.insurer",
"Claim.organization",
"ClaimResponse.insurer",
"Communication.sender",
"Communication.recipient",
"CommunicationRequest.requester",
"CommunicationRequest.sender",
"CommunicationRequest.recipient",
"Composition.attester",
"Consent.actor",
"Consent.organization",
"Consent.consentor",
"Contract.agent",
"Contract.authority",
"Contract.signer",
"Coverage.payor",
"Coverage.policy-holder",
"Device.organization",
"DeviceRequest.requester",
"DeviceRequest.performer",
"DiagnosticReport.performer",
"DocumentManifest.author",
"DocumentManifest.recipient",
"DocumentReference.authenticator",
"DocumentReference.custodian",
"DocumentReference.author",
"EligibilityRequest.organization",
"EligibilityResponse.insurer",
"EligibilityResponse.request-organization",
"Encounter.service-provider",
"Endpoint.organization",
"EnrollmentRequest.organization",
"EnrollmentResponse.organization",
"EpisodeOfCare.organization",
"ExplanationOfBenefit.care-team",
"ExplanationOfBenefit.payee",
"ExplanationOfBenefit.organization",
"Flag.subject",
"Flag.patient",
"Flag.author",
"Goal.patient",
"Goal.subject",
"HealthcareService.organization",
"ImagingManifest.author",
"Immunization.manufacturer",
"Linkage.author",
"Location.organization",
"Medication.manufacturer",
"MedicationDispense.performer",
"MedicationRequest.requester",
"MedicationRequest.intended-dispenser",
"MedicationStatement.source",
"MessageHeader.receiver",
"MessageHeader.sender",
"MessageHeader.responsible",
"Observation.performer",
"Organization.partof",
"Patient.general-practitioner",
"Patient.organization",
"PaymentNotice.organization",
"PaymentReconciliation.organization",
"PaymentReconciliation.request-organization",
"Person.organization",
"PractitionerRole.organization",
"Procedure.performer",
"ProcedureRequest.requester",
"ProcedureRequest.performer",
"ProcessRequest.organization",
"ProcessResponse.organization",
"ProcessResponse.request-organization",
"Provenance.agent",
"ReferralRequest.requester",
"ReferralRequest.recipient",
"ResearchStudy.sponsor",
"SupplyDelivery.supplier",
"SupplyRequest.requester",
"SupplyRequest.supplier",
"Task.owner",
"Task.requester",
"Task.organization"
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Organization-identifier",
"type": "token",
"documentation": "Any identifier for the organization (not the accreditation issuer's identifier)"
},
{
"name": "partof",
"definition": "http://hl7.org/fhir/SearchParameter/Organization-partof",
"type": "reference",
"documentation": "An organization of which this organization forms a part"
},
{
"name": "address",
"definition": "http://hl7.org/fhir/SearchParameter/Organization-address",
"type": "string",
"documentation": "A (part of the) address of the organization"
},
{
"name": "address-state",
"definition": "http://hl7.org/fhir/SearchParameter/Organization-address-state",
"type": "string",
"documentation": "A state specified in an address"
},
{
"name": "active",
"definition": "http://hl7.org/fhir/SearchParameter/Organization-active",
"type": "token",
"documentation": "A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/Organization-type",
"type": "token",
"documentation": "A code for the type of organization"
},
{
"name": "address-postalcode",
"definition": "http://hl7.org/fhir/SearchParameter/Organization-address-postalcode",
"type": "string",
"documentation": "A postal code specified in an address"
},
{
"name": "address-country",
"definition": "http://hl7.org/fhir/SearchParameter/Organization-address-country",
"type": "string",
"documentation": "A country specified in an address"
},
{
"name": "endpoint",
"definition": "http://hl7.org/fhir/SearchParameter/Organization-endpoint",
"type": "reference",
"documentation": "Technical endpoints providing access to services operated for the organization"
},
{
"name": "phonetic",
"definition": "http://hl7.org/fhir/SearchParameter/Organization-phonetic",
"type": "string",
"documentation": "A portion of the organization's name using some kind of phonetic matching algorithm"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/Organization-name",
"type": "string",
"documentation": "A portion of the organization's name or alias"
},
{
"name": "address-use",
"definition": "http://hl7.org/fhir/SearchParameter/Organization-address-use",
"type": "token",
"documentation": "A use code specified in an address"
},
{
"name": "address-city",
"definition": "http://hl7.org/fhir/SearchParameter/Organization-address-city",
"type": "string",
"documentation": "A city specified in an address"
}
]
},
{
"type": "Patient",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Patient"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Patient.link",
"Patient.general-practitioner",
"Patient.organization"
],
"searchRevInclude": [
"Account.subject",
"Account.patient",
"AdverseEvent.recorder",
"AdverseEvent.subject",
"AllergyIntolerance.recorder",
"AllergyIntolerance.asserter",
"AllergyIntolerance.patient",
"Appointment.actor",
"Appointment.practitioner",
"Appointment.patient",
"Appointment.location",
"AppointmentResponse.actor",
"AppointmentResponse.practitioner",
"AppointmentResponse.patient",
"AppointmentResponse.location",
"AuditEvent.agent",
"AuditEvent.patient",
"Basic.author",
"BodySite.patient",
"CarePlan.performer",
"CarePlan.subject",
"CarePlan.patient",
"CareTeam.patient",
"CareTeam.subject",
"CareTeam.participant",
"ChargeItem.subject",
"ChargeItem.participant-actor",
"ChargeItem.patient",
"ChargeItem.enterer",
"Claim.payee",
"Claim.patient",
"ClaimResponse.patient",
"ClinicalImpression.subject",
"ClinicalImpression.patient",
"Communication.subject",
"Communication.sender",
"Communication.patient",
"Communication.recipient",
"CommunicationRequest.requester",
"CommunicationRequest.subject",
"CommunicationRequest.sender",
"CommunicationRequest.patient",
"CommunicationRequest.recipient",
"Composition.author",
"Composition.attester",
"Condition.subject",
"Condition.asserter",
"Condition.patient",
"Consent.actor",
"Consent.patient",
"Consent.consentor",
"Contract.agent",
"Contract.signer",
"Coverage.subscriber",
"Coverage.payor",
"Coverage.beneficiary",
"Coverage.policy-holder",
"DetectedIssue.patient",
"Device.patient",
"DeviceRequest.performer",
"DeviceRequest.subject",
"DeviceRequest.patient",
"DeviceUseStatement.subject",
"DeviceUseStatement.patient",
"DiagnosticReport.subject",
"DiagnosticReport.patient",
"DocumentManifest.subject",
"DocumentManifest.author",
"DocumentManifest.patient",
"DocumentManifest.recipient",
"DocumentReference.subject",
"DocumentReference.patient",
"DocumentReference.author",
"EligibilityRequest.patient",
"Encounter.subject",
"Encounter.patient",
"EnrollmentRequest.subject",
"EnrollmentRequest.patient",
"EpisodeOfCare.patient",
"ExplanationOfBenefit.payee",
"ExplanationOfBenefit.patient",
"FamilyMemberHistory.patient",
"Flag.subject",
"Flag.patient",
"Flag.author",
"Goal.patient",
"Goal.subject",
"Group.member",
"GuidanceResponse.patient",
"GuidanceResponse.subject",
"ImagingManifest.author",
"ImagingManifest.patient",
"ImagingStudy.patient",
"Immunization.patient",
"ImmunizationRecommendation.patient",
"List.subject",
"List.patient",
"List.source",
"MeasureReport.patient",
"Media.subject",
"Media.patient",
"MedicationAdministration.performer",
"MedicationAdministration.subject",
"MedicationAdministration.patient",
"MedicationDispense.performer",
"MedicationDispense.receiver",
"MedicationDispense.subject",
"MedicationDispense.patient",
"MedicationRequest.requester",
"MedicationRequest.subject",
"MedicationRequest.patient",
"MedicationStatement.subject",
"MedicationStatement.patient",
"MedicationStatement.source",
"NutritionOrder.patient",
"Observation.subject",
"Observation.patient",
"Observation.performer",
"Patient.link",
"Person.practitioner",
"Person.link",
"Person.relatedperson",
"Person.patient",
"Procedure.performer",
"Procedure.subject",
"Procedure.patient",
"ProcedureRequest.performer",
"ProcedureRequest.subject",
"ProcedureRequest.patient",
"Provenance.agent",
"QuestionnaireResponse.author",
"QuestionnaireResponse.source",
"ReferralRequest.requester",
"ReferralRequest.subject",
"ReferralRequest.patient",
"RelatedPerson.patient",
"RequestGroup.subject",
"RequestGroup.participant",
"RequestGroup.patient",
"ResearchSubject.individual",
"ResearchSubject.patient",
"RiskAssessment.subject",
"RiskAssessment.patient",
"Schedule.actor",
"Sequence.patient",
"Specimen.subject",
"Specimen.patient",
"SupplyDelivery.patient",
"SupplyRequest.requester",
"Task.owner",
"Task.requester",
"VisionPrescription.patient"
],
"searchParam": [
{
"name": "birthdate",
"definition": "http://hl7.org/fhir/SearchParameter/individual-birthdate",
"type": "date",
"documentation": "The patient's date of birth"
},
{
"name": "deceased",
"definition": "http://hl7.org/fhir/SearchParameter/Patient-deceased",
"type": "token",
"documentation": "This patient has been marked as deceased, or as a death date entered"
},
{
"name": "address-state",
"definition": "http://hl7.org/fhir/SearchParameter/individual-address-state",
"type": "string",
"documentation": "A state specified in an address"
},
{
"name": "gender",
"definition": "http://hl7.org/fhir/SearchParameter/individual-gender",
"type": "token",
"documentation": "Gender of the patient"
},
{
"name": "animal-species",
"definition": "http://hl7.org/fhir/SearchParameter/Patient-animal-species",
"type": "token",
"documentation": "The species for animal patients"
},
{
"name": "link",
"definition": "http://hl7.org/fhir/SearchParameter/Patient-link",
"type": "reference",
"documentation": "All patients linked to the given patient"
},
{
"name": "language",
"definition": "http://hl7.org/fhir/SearchParameter/Patient-language",
"type": "token",
"documentation": "Language code (irrespective of use value)"
},
{
"name": "animal-breed",
"definition": "http://hl7.org/fhir/SearchParameter/Patient-animal-breed",
"type": "token",
"documentation": "The breed for animal patients"
},
{
"name": "address-country",
"definition": "http://hl7.org/fhir/SearchParameter/individual-address-country",
"type": "string",
"documentation": "A country specified in an address"
},
{
"name": "death-date",
"definition": "http://hl7.org/fhir/SearchParameter/Patient-death-date",
"type": "date",
"documentation": "The date of death has been provided and satisfies this search value"
},
{
"name": "phonetic",
"definition": "http://hl7.org/fhir/SearchParameter/individual-phonetic",
"type": "string",
"documentation": "A portion of either family or given name using some kind of phonetic matching algorithm"
},
{
"name": "telecom",
"definition": "http://hl7.org/fhir/SearchParameter/individual-telecom",
"type": "token",
"documentation": "The value in any kind of telecom details of the patient"
},
{
"name": "address-city",
"definition": "http://hl7.org/fhir/SearchParameter/individual-address-city",
"type": "string",
"documentation": "A city specified in an address"
},
{
"name": "email",
"definition": "http://hl7.org/fhir/SearchParameter/individual-email",
"type": "token",
"documentation": "A value in an email contact"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Patient-identifier",
"type": "token",
"documentation": "A patient identifier"
},
{
"name": "given",
"definition": "http://hl7.org/fhir/SearchParameter/individual-given",
"type": "string",
"documentation": "A portion of the given name of the patient"
},
{
"name": "address",
"definition": "http://hl7.org/fhir/SearchParameter/individual-address",
"type": "string",
"documentation": "A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text"
},
{
"name": "general-practitioner",
"definition": "http://hl7.org/fhir/SearchParameter/Patient-general-practitioner",
"type": "reference",
"documentation": "Patient's nominated general practitioner, not the organization that manages the record"
},
{
"name": "active",
"definition": "http://hl7.org/fhir/SearchParameter/Patient-active",
"type": "token",
"documentation": "Whether the patient record is active"
},
{
"name": "address-postalcode",
"definition": "http://hl7.org/fhir/SearchParameter/individual-address-postalcode",
"type": "string",
"documentation": "A postalCode specified in an address"
},
{
"name": "phone",
"definition": "http://hl7.org/fhir/SearchParameter/individual-phone",
"type": "token",
"documentation": "A value in a phone contact"
},
{
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/Patient-organization",
"type": "reference",
"documentation": "The organization at which this person is a patient"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/Patient-name",
"type": "string",
"documentation": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text"
},
{
"name": "address-use",
"definition": "http://hl7.org/fhir/SearchParameter/individual-address-use",
"type": "token",
"documentation": "A use code specified in an address"
},
{
"name": "family",
"definition": "http://hl7.org/fhir/SearchParameter/individual-family",
"type": "string",
"documentation": "A portion of the family name of the patient"
}
]
},
{
"type": "PaymentNotice",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/PaymentNotice"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"PaymentNotice.request",
"PaymentNotice.provider",
"PaymentNotice.response",
"PaymentNotice.organization"
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/PaymentNotice-identifier",
"type": "token",
"documentation": "The business identifier of the notice"
},
{
"name": "request",
"definition": "http://hl7.org/fhir/SearchParameter/PaymentNotice-request",
"type": "reference",
"documentation": "The Claim"
},
{
"name": "provider",
"definition": "http://hl7.org/fhir/SearchParameter/PaymentNotice-provider",
"type": "reference",
"documentation": "The reference to the provider"
},
{
"name": "created",
"definition": "http://hl7.org/fhir/SearchParameter/PaymentNotice-created",
"type": "date",
"documentation": "Creation date fro the notice"
},
{
"name": "response",
"definition": "http://hl7.org/fhir/SearchParameter/PaymentNotice-response",
"type": "reference",
"documentation": "The ClaimResponse"
},
{
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/PaymentNotice-organization",
"type": "reference",
"documentation": "The organization who generated this resource"
},
{
"name": "payment-status",
"definition": "http://hl7.org/fhir/SearchParameter/PaymentNotice-payment-status",
"type": "token",
"documentation": "The type of payment notice"
},
{
"name": "statusdate",
"definition": "http://hl7.org/fhir/SearchParameter/PaymentNotice-statusdate",
"type": "date",
"documentation": "The date of the payment action"
}
]
},
{
"type": "PaymentReconciliation",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/PaymentReconciliation"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"PaymentReconciliation.request",
"PaymentReconciliation.organization",
"PaymentReconciliation.request-organization",
"PaymentReconciliation.request-provider"
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/PaymentReconciliation-identifier",
"type": "token",
"documentation": "The business identifier of the Explanation of Benefit"
},
{
"name": "request",
"definition": "http://hl7.org/fhir/SearchParameter/PaymentReconciliation-request",
"type": "reference",
"documentation": "The reference to the claim"
},
{
"name": "disposition",
"definition": "http://hl7.org/fhir/SearchParameter/PaymentReconciliation-disposition",
"type": "string",
"documentation": "The contents of the disposition message"
},
{
"name": "created",
"definition": "http://hl7.org/fhir/SearchParameter/PaymentReconciliation-created",
"type": "date",
"documentation": "The creation date"
},
{
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/PaymentReconciliation-organization",
"type": "reference",
"documentation": "The organization who generated this resource"
},
{
"name": "request-organization",
"definition": "http://hl7.org/fhir/SearchParameter/PaymentReconciliation-request-organization",
"type": "reference",
"documentation": "The organization who generated this resource"
},
{
"name": "request-provider",
"definition": "http://hl7.org/fhir/SearchParameter/PaymentReconciliation-request-provider",
"type": "reference",
"documentation": "The reference to the provider who sumbitted the claim"
},
{
"name": "outcome",
"definition": "http://hl7.org/fhir/SearchParameter/PaymentReconciliation-outcome",
"type": "token",
"documentation": "The processing outcome"
}
]
},
{
"type": "Person",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Person"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Person.practitioner",
"Person.link",
"Person.relatedperson",
"Person.patient",
"Person.organization"
],
"searchRevInclude": [
"Person.practitioner",
"Person.link",
"Person.relatedperson",
"Person.patient",
"RequestGroup.participant"
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Person-identifier",
"type": "token",
"documentation": "A person Identifier"
},
{
"name": "address",
"definition": "http://hl7.org/fhir/SearchParameter/individual-address",
"type": "string",
"documentation": "A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text"
},
{
"name": "birthdate",
"definition": "http://hl7.org/fhir/SearchParameter/individual-birthdate",
"type": "date",
"documentation": "The person's date of birth"
},
{
"name": "address-state",
"definition": "http://hl7.org/fhir/SearchParameter/individual-address-state",
"type": "string",
"documentation": "A state specified in an address"
},
{
"name": "gender",
"definition": "http://hl7.org/fhir/SearchParameter/individual-gender",
"type": "token",
"documentation": "The gender of the person"
},
{
"name": "practitioner",
"definition": "http://hl7.org/fhir/SearchParameter/Person-practitioner",
"type": "reference",
"documentation": "The Person links to this Practitioner"
},
{
"name": "link",
"definition": "http://hl7.org/fhir/SearchParameter/Person-link",
"type": "reference",
"documentation": "Any link has this Patient, Person, RelatedPerson or Practitioner reference"
},
{
"name": "relatedperson",
"definition": "http://hl7.org/fhir/SearchParameter/Person-relatedperson",
"type": "reference",
"documentation": "The Person links to this RelatedPerson"
},
{
"name": "address-postalcode",
"definition": "http://hl7.org/fhir/SearchParameter/individual-address-postalcode",
"type": "string",
"documentation": "A postal code specified in an address"
},
{
"name": "address-country",
"definition": "http://hl7.org/fhir/SearchParameter/individual-address-country",
"type": "string",
"documentation": "A country specified in an address"
},
{
"name": "phonetic",
"definition": "http://hl7.org/fhir/SearchParameter/individual-phonetic",
"type": "string",
"documentation": "A portion of name using some kind of phonetic matching algorithm"
},
{
"name": "phone",
"definition": "http://hl7.org/fhir/SearchParameter/individual-phone",
"type": "token",
"documentation": "A value in a phone contact"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/Person-patient",
"type": "reference",
"documentation": "The Person links to this Patient"
},
{
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/Person-organization",
"type": "reference",
"documentation": "The organization at which this person record is being managed"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/Person-name",
"type": "string",
"documentation": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text"
},
{
"name": "address-use",
"definition": "http://hl7.org/fhir/SearchParameter/individual-address-use",
"type": "token",
"documentation": "A use code specified in an address"
},
{
"name": "telecom",
"definition": "http://hl7.org/fhir/SearchParameter/individual-telecom",
"type": "token",
"documentation": "The value in any kind of contact"
},
{
"name": "address-city",
"definition": "http://hl7.org/fhir/SearchParameter/individual-address-city",
"type": "string",
"documentation": "A city specified in an address"
},
{
"name": "email",
"definition": "http://hl7.org/fhir/SearchParameter/individual-email",
"type": "token",
"documentation": "A value in an email contact"
}
]
},
{
"type": "PlanDefinition",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/PlanDefinition"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"PlanDefinition.successor",
"PlanDefinition.derived-from",
"PlanDefinition.predecessor",
"PlanDefinition.composed-of",
"PlanDefinition.depends-on"
],
"searchRevInclude": [
"CarePlan.definition",
"Communication.definition",
"DeviceRequest.definition",
"FamilyMemberHistory.definition",
"Flag.subject",
"Flag.patient",
"Procedure.definition",
"ProcedureRequest.definition",
"ReferralRequest.definition",
"ResearchStudy.protocol"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-date",
"type": "date",
"documentation": "The plan definition publication date"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-identifier",
"type": "token",
"documentation": "External identifier for the plan definition"
},
{
"name": "successor",
"definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-successor",
"type": "reference",
"documentation": "What resource is being referenced"
},
{
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the plan definition"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-description",
"type": "string",
"documentation": "The description of the plan definition"
},
{
"name": "derived-from",
"definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-derived-from",
"type": "reference",
"documentation": "What resource is being referenced"
},
{
"name": "predecessor",
"definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-predecessor",
"type": "reference",
"documentation": "What resource is being referenced"
},
{
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-title",
"type": "string",
"documentation": "The human-friendly name of the plan definition"
},
{
"name": "composed-of",
"definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-composed-of",
"type": "reference",
"documentation": "What resource is being referenced"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-version",
"type": "token",
"documentation": "The business version of the plan definition"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-url",
"type": "uri",
"documentation": "The uri that identifies the plan definition"
},
{
"name": "effective",
"definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-effective",
"type": "date",
"documentation": "The time during which the plan definition is intended to be in use"
},
{
"name": "depends-on",
"definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-depends-on",
"type": "reference",
"documentation": "What resource is being referenced"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-name",
"type": "string",
"documentation": "Computationally friendly name of the plan definition"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-publisher",
"type": "string",
"documentation": "Name of the publisher of the plan definition"
},
{
"name": "topic",
"definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-topic",
"type": "token",
"documentation": "Topics associated with the module"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-status",
"type": "token",
"documentation": "The current status of the plan definition"
}
]
},
{
"type": "Practitioner",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchRevInclude": [
"Account.subject",
"Account.patient",
"AdverseEvent.recorder",
"AllergyIntolerance.recorder",
"AllergyIntolerance.asserter",
"Appointment.actor",
"Appointment.practitioner",
"Appointment.patient",
"Appointment.location",
"AppointmentResponse.actor",
"AppointmentResponse.practitioner",
"AppointmentResponse.patient",
"AppointmentResponse.location",
"AuditEvent.agent",
"AuditEvent.patient",
"Basic.author",
"CarePlan.performer",
"CareTeam.participant",
"ChargeItem.participant-actor",
"ChargeItem.enterer",
"Claim.care-team",
"Claim.payee",
"Claim.provider",
"Claim.enterer",
"ClaimResponse.request-provider",
"ClinicalImpression.assessor",
"Communication.sender",
"Communication.recipient",
"CommunicationRequest.requester",
"CommunicationRequest.sender",
"CommunicationRequest.recipient",
"Composition.author",
"Composition.attester",
"Condition.asserter",
"Consent.actor",
"Consent.consentor",
"Contract.agent",
"Contract.signer",
"DetectedIssue.author",
"DeviceRequest.requester",
"DeviceRequest.performer",
"DiagnosticReport.performer",
"DocumentManifest.subject",
"DocumentManifest.author",
"DocumentManifest.patient",
"DocumentManifest.recipient",
"DocumentReference.subject",
"DocumentReference.patient",
"DocumentReference.authenticator",
"DocumentReference.author",
"EligibilityRequest.provider",
"EligibilityRequest.enterer",
"EligibilityResponse.request-provider",
"Encounter.practitioner",
"Encounter.participant",
"EpisodeOfCare.care-manager",
"ExplanationOfBenefit.care-team",
"ExplanationOfBenefit.payee",
"ExplanationOfBenefit.provider",
"ExplanationOfBenefit.enterer",
"Flag.subject",
"Flag.patient",
"Flag.author",
"Group.member",
"ImagingManifest.author",
"ImagingStudy.performer",
"Immunization.practitioner",
"Linkage.author",
"List.source",
"Media.subject",
"Media.operator",
"Media.patient",
"MedicationAdministration.performer",
"MedicationDispense.performer",
"MedicationDispense.receiver",
"MedicationDispense.responsibleparty",
"MedicationRequest.requester",
"MedicationStatement.source",
"MessageHeader.receiver",
"MessageHeader.author",
"MessageHeader.sender",
"MessageHeader.responsible",
"MessageHeader.enterer",
"NutritionOrder.provider",
"Observation.performer",
"Patient.general-practitioner",
"PaymentNotice.provider",
"PaymentReconciliation.request-provider",
"Person.practitioner",
"Person.link",
"Person.relatedperson",
"Person.patient",
"PractitionerRole.practitioner",
"Procedure.performer",
"ProcedureRequest.requester",
"ProcedureRequest.performer",
"ProcessRequest.provider",
"ProcessResponse.request-provider",
"Provenance.agent",
"QuestionnaireResponse.author",
"QuestionnaireResponse.source",
"ReferralRequest.requester",
"ReferralRequest.recipient",
"RequestGroup.author",
"RequestGroup.participant",
"ResearchStudy.principalinvestigator",
"RiskAssessment.performer",
"Schedule.actor",
"Specimen.collector",
"SupplyDelivery.receiver",
"SupplyDelivery.supplier",
"SupplyRequest.requester",
"Task.owner",
"Task.requester",
"VisionPrescription.prescriber"
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Practitioner-identifier",
"type": "token",
"documentation": "A practitioner's Identifier"
},
{
"name": "given",
"definition": "http://hl7.org/fhir/SearchParameter/individual-given",
"type": "string",
"documentation": "A portion of the given name"
},
{
"name": "address",
"definition": "http://hl7.org/fhir/SearchParameter/individual-address",
"type": "string",
"documentation": "A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text"
},
{
"name": "address-state",
"definition": "http://hl7.org/fhir/SearchParameter/individual-address-state",
"type": "string",
"documentation": "A state specified in an address"
},
{
"name": "gender",
"definition": "http://hl7.org/fhir/SearchParameter/individual-gender",
"type": "token",
"documentation": "Gender of the practitioner"
},
{
"name": "active",
"definition": "http://hl7.org/fhir/SearchParameter/Practitioner-active",
"type": "token",
"documentation": "Whether the practitioner record is active"
},
{
"name": "address-postalcode",
"definition": "http://hl7.org/fhir/SearchParameter/individual-address-postalcode",
"type": "string",
"documentation": "A postalCode specified in an address"
},
{
"name": "address-country",
"definition": "http://hl7.org/fhir/SearchParameter/individual-address-country",
"type": "string",
"documentation": "A country specified in an address"
},
{
"name": "phonetic",
"definition": "http://hl7.org/fhir/SearchParameter/individual-phonetic",
"type": "string",
"documentation": "A portion of either family or given name using some kind of phonetic matching algorithm"
},
{
"name": "phone",
"definition": "http://hl7.org/fhir/SearchParameter/individual-phone",
"type": "token",
"documentation": "A value in a phone contact"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/Practitioner-name",
"type": "string",
"documentation": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text"
},
{
"name": "address-use",
"definition": "http://hl7.org/fhir/SearchParameter/individual-address-use",
"type": "token",
"documentation": "A use code specified in an address"
},
{
"name": "telecom",
"definition": "http://hl7.org/fhir/SearchParameter/individual-telecom",
"type": "token",
"documentation": "The value in any kind of contact"
},
{
"name": "family",
"definition": "http://hl7.org/fhir/SearchParameter/individual-family",
"type": "string",
"documentation": "A portion of the family name"
},
{
"name": "address-city",
"definition": "http://hl7.org/fhir/SearchParameter/individual-address-city",
"type": "string",
"documentation": "A city specified in an address"
},
{
"name": "communication",
"definition": "http://hl7.org/fhir/SearchParameter/Practitioner-communication",
"type": "token",
"documentation": "One of the languages that the practitioner can communicate with"
},
{
"name": "email",
"definition": "http://hl7.org/fhir/SearchParameter/individual-email",
"type": "token",
"documentation": "A value in an email contact"
}
]
},
{
"type": "PractitionerRole",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/PractitionerRole"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"PractitionerRole.practitioner",
"PractitionerRole.endpoint",
"PractitionerRole.service",
"PractitionerRole.organization",
"PractitionerRole.location"
],
"searchRevInclude": [
"Schedule.actor"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/PractitionerRole-date",
"type": "date",
"documentation": "The period during which the practitioner is authorized to perform in these role(s)"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/PractitionerRole-identifier",
"type": "token",
"documentation": "A practitioner's Identifier"
},
{
"name": "specialty",
"definition": "http://hl7.org/fhir/SearchParameter/PractitionerRole-specialty",
"type": "token",
"documentation": "The practitioner has this specialty at an organization"
},
{
"name": "role",
"definition": "http://hl7.org/fhir/SearchParameter/PractitionerRole-role",
"type": "token",
"documentation": "The practitioner can perform this role at for the organization"
},
{
"name": "practitioner",
"definition": "http://hl7.org/fhir/SearchParameter/PractitionerRole-practitioner",
"type": "reference",
"documentation": "Practitioner that is able to provide the defined services for the organation"
},
{
"name": "active",
"definition": "http://hl7.org/fhir/SearchParameter/PractitionerRole-active",
"type": "token",
"documentation": "Whether this practitioner's record is in active use"
},
{
"name": "endpoint",
"definition": "http://hl7.org/fhir/SearchParameter/PractitionerRole-endpoint",
"type": "reference",
"documentation": "Technical endpoints providing access to services operated for the practitioner with this role"
},
{
"name": "phone",
"definition": "http://hl7.org/fhir/SearchParameter/individual-phone",
"type": "token",
"documentation": "A value in a phone contact"
},
{
"name": "service",
"definition": "http://hl7.org/fhir/SearchParameter/PractitionerRole-service",
"type": "reference",
"documentation": "The list of healthcare services that this worker provides for this role's Organization/Location(s)"
},
{
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/PractitionerRole-organization",
"type": "reference",
"documentation": "The identity of the organization the practitioner represents / acts on behalf of"
},
{
"name": "telecom",
"definition": "http://hl7.org/fhir/SearchParameter/individual-telecom",
"type": "token",
"documentation": "The value in any kind of contact"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/PractitionerRole-location",
"type": "reference",
"documentation": "One of the locations at which this practitioner provides care"
},
{
"name": "email",
"definition": "http://hl7.org/fhir/SearchParameter/individual-email",
"type": "token",
"documentation": "A value in an email contact"
}
]
},
{
"type": "Procedure",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Procedure"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Procedure.performer",
"Procedure.subject",
"Procedure.part-of",
"Procedure.encounter",
"Procedure.based-on",
"Procedure.patient",
"Procedure.context",
"Procedure.location",
"Procedure.definition"
],
"searchRevInclude": [
"ChargeItem.service",
"ClinicalImpression.action",
"Encounter.diagnosis",
"Flag.subject",
"Flag.patient",
"MedicationStatement.part-of",
"Procedure.part-of",
"QuestionnaireResponse.parent"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"type": "date",
"documentation": "Date/Period the procedure was performed"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "A unique identifier for a procedure"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"type": "token",
"documentation": "A code to identify a procedure"
},
{
"name": "performer",
"definition": "http://hl7.org/fhir/SearchParameter/Procedure-performer",
"type": "reference",
"documentation": "The reference to the practitioner"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/Procedure-subject",
"type": "reference",
"documentation": "Search by subject"
},
{
"name": "part-of",
"definition": "http://hl7.org/fhir/SearchParameter/Procedure-part-of",
"type": "reference",
"documentation": "Part of referenced event"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"type": "reference",
"documentation": "Search by encounter"
},
{
"name": "based-on",
"definition": "http://hl7.org/fhir/SearchParameter/Procedure-based-on",
"type": "reference",
"documentation": "A request for this procedure"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Search by subject - a patient"
},
{
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/Procedure-context",
"type": "reference",
"documentation": "Encounter or episode associated with the procedure"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/Procedure-location",
"type": "reference",
"documentation": "Where the procedure happened"
},
{
"name": "definition",
"definition": "http://hl7.org/fhir/SearchParameter/Procedure-definition",
"type": "reference",
"documentation": "Instantiates protocol or definition"
},
{
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/Procedure-category",
"type": "token",
"documentation": "Classification of the procedure"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Procedure-status",
"type": "token",
"documentation": "preparation | in-progress | suspended | aborted | completed | entered-in-error | unknown"
}
]
},
{
"type": "ProcedureRequest",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/ProcedureRequest"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"ProcedureRequest.requester",
"ProcedureRequest.performer",
"ProcedureRequest.replaces",
"ProcedureRequest.subject",
"ProcedureRequest.encounter",
"ProcedureRequest.based-on",
"ProcedureRequest.patient",
"ProcedureRequest.specimen",
"ProcedureRequest.context",
"ProcedureRequest.definition"
],
"searchRevInclude": [
"CarePlan.activity-reference",
"ClinicalImpression.action",
"DiagnosticReport.based-on",
"ImagingStudy.basedon",
"Media.based-on",
"Observation.based-on",
"Procedure.based-on",
"QuestionnaireResponse.based-on",
"ReferralRequest.based-on"
],
"searchParam": [
{
"name": "authored",
"definition": "http://hl7.org/fhir/SearchParameter/ProcedureRequest-authored",
"type": "date",
"documentation": "Date request signed"
},
{
"name": "requester",
"definition": "http://hl7.org/fhir/SearchParameter/ProcedureRequest-requester",
"type": "reference",
"documentation": "Individual making the request"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "Identifiers assigned to this order"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"type": "token",
"documentation": "What is being requested/ordered"
},
{
"name": "performer",
"definition": "http://hl7.org/fhir/SearchParameter/ProcedureRequest-performer",
"type": "reference",
"documentation": "Requested perfomer"
},
{
"name": "requisition",
"definition": "http://hl7.org/fhir/SearchParameter/ProcedureRequest-requisition",
"type": "token",
"documentation": "Composite Request ID"
},
{
"name": "replaces",
"definition": "http://hl7.org/fhir/SearchParameter/ProcedureRequest-replaces",
"type": "reference",
"documentation": "What request replaces"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/ProcedureRequest-subject",
"type": "reference",
"documentation": "Search by subject"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"type": "reference",
"documentation": "An encounter in which this request is made"
},
{
"name": "occurrence",
"definition": "http://hl7.org/fhir/SearchParameter/ProcedureRequest-occurrence",
"type": "date",
"documentation": "When procedure should occur"
},
{
"name": "priority",
"definition": "http://hl7.org/fhir/SearchParameter/ProcedureRequest-priority",
"type": "token",
"documentation": "routine | urgent | asap | stat"
},
{
"name": "intent",
"definition": "http://hl7.org/fhir/SearchParameter/ProcedureRequest-intent",
"type": "token",
"documentation": "proposal | plan | order +"
},
{
"name": "performer-type",
"definition": "http://hl7.org/fhir/SearchParameter/ProcedureRequest-performer-type",
"type": "token",
"documentation": "Performer role"
},
{
"name": "based-on",
"definition": "http://hl7.org/fhir/SearchParameter/ProcedureRequest-based-on",
"type": "reference",
"documentation": "What request fulfills"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Search by subject - a patient"
},
{
"name": "specimen",
"definition": "http://hl7.org/fhir/SearchParameter/ProcedureRequest-specimen",
"type": "reference",
"documentation": "Specimen to be tested"
},
{
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/ProcedureRequest-context",
"type": "reference",
"documentation": "Encounter or Episode during which request was created"
},
{
"name": "definition",
"definition": "http://hl7.org/fhir/SearchParameter/ProcedureRequest-definition",
"type": "reference",
"documentation": "Protocol or definition"
},
{
"name": "body-site",
"definition": "http://hl7.org/fhir/SearchParameter/ProcedureRequest-body-site",
"type": "token",
"documentation": "Where procedure is going to be done"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/ProcedureRequest-status",
"type": "token",
"documentation": "draft | active | suspended | completed | entered-in-error | cancelled"
}
]
},
{
"type": "ProcessRequest",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/ProcessRequest"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"ProcessRequest.provider",
"ProcessRequest.organization"
],
"searchRevInclude": [
"PaymentReconciliation.request"
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/ProcessRequest-identifier",
"type": "token",
"documentation": "The business identifier of the ProcessRequest"
},
{
"name": "provider",
"definition": "http://hl7.org/fhir/SearchParameter/ProcessRequest-provider",
"type": "reference",
"documentation": "The provider who regenerated this request"
},
{
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/ProcessRequest-organization",
"type": "reference",
"documentation": "The organization who generated this request"
},
{
"name": "action",
"definition": "http://hl7.org/fhir/SearchParameter/ProcessRequest-action",
"type": "token",
"documentation": "The action requested by this resource"
}
]
},
{
"type": "ProcessResponse",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/ProcessResponse"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"ProcessResponse.request",
"ProcessResponse.organization",
"ProcessResponse.request-organization",
"ProcessResponse.request-provider"
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/ProcessResponse-identifier",
"type": "token",
"documentation": "The business identifier of the Explanation of Benefit"
},
{
"name": "request",
"definition": "http://hl7.org/fhir/SearchParameter/ProcessResponse-request",
"type": "reference",
"documentation": "The reference to the claim"
},
{
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/ProcessResponse-organization",
"type": "reference",
"documentation": "The organization who generated this resource"
},
{
"name": "request-organization",
"definition": "http://hl7.org/fhir/SearchParameter/ProcessResponse-request-organization",
"type": "reference",
"documentation": "The Organization who is responsible the request transaction"
},
{
"name": "request-provider",
"definition": "http://hl7.org/fhir/SearchParameter/ProcessResponse-request-provider",
"type": "reference",
"documentation": "The Provider who is responsible the request transaction"
}
]
},
{
"type": "Provenance",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Provenance"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Provenance.entity-ref",
"Provenance.agent",
"Provenance.patient",
"Provenance.location",
"Provenance.target"
],
"searchParam": [
{
"name": "entity-ref",
"definition": "http://hl7.org/fhir/SearchParameter/Provenance-entity-ref",
"type": "reference",
"documentation": "Identity of entity"
},
{
"name": "agent",
"definition": "http://hl7.org/fhir/SearchParameter/Provenance-agent",
"type": "reference",
"documentation": "Who participated"
},
{
"name": "signature-type",
"definition": "http://hl7.org/fhir/SearchParameter/Provenance-signature-type",
"type": "token",
"documentation": "Indication of the reason the entity signed the object(s)"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/Provenance-patient",
"type": "reference",
"documentation": "Target Reference(s) (usually version specific)"
},
{
"name": "start",
"definition": "http://hl7.org/fhir/SearchParameter/Provenance-start",
"type": "date",
"documentation": "Starting time with inclusive boundary"
},
{
"name": "end",
"definition": "http://hl7.org/fhir/SearchParameter/Provenance-end",
"type": "date",
"documentation": "End time with inclusive boundary, if not ongoing"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/Provenance-location",
"type": "reference",
"documentation": "Where the activity occurred, if relevant"
},
{
"name": "recorded",
"definition": "http://hl7.org/fhir/SearchParameter/Provenance-recorded",
"type": "date",
"documentation": "When the activity was recorded / updated"
},
{
"name": "agent-role",
"definition": "http://hl7.org/fhir/SearchParameter/Provenance-agent-role",
"type": "token",
"documentation": "What the agents role was"
},
{
"name": "entity-id",
"definition": "http://hl7.org/fhir/SearchParameter/Provenance-entity-id",
"type": "token",
"documentation": "Identity of entity"
},
{
"name": "target",
"definition": "http://hl7.org/fhir/SearchParameter/Provenance-target",
"type": "reference",
"documentation": "Target Reference(s) (usually version specific)"
}
]
},
{
"type": "Questionnaire",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Questionnaire"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchRevInclude": [
"CarePlan.definition",
"FamilyMemberHistory.definition",
"QuestionnaireResponse.questionnaire"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/Questionnaire-date",
"type": "date",
"documentation": "The questionnaire publication date"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Questionnaire-identifier",
"type": "token",
"documentation": "External identifier for the questionnaire"
},
{
"name": "effective",
"definition": "http://hl7.org/fhir/SearchParameter/Questionnaire-effective",
"type": "date",
"documentation": "The time during which the questionnaire is intended to be in use"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/Questionnaire-code",
"type": "token",
"documentation": "A code that corresponds to one of its items in the questionnaire"
},
{
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/Questionnaire-jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the questionnaire"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/Questionnaire-name",
"type": "string",
"documentation": "Computationally friendly name of the questionnaire"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/Questionnaire-description",
"type": "string",
"documentation": "The description of the questionnaire"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/Questionnaire-publisher",
"type": "string",
"documentation": "Name of the publisher of the questionnaire"
},
{
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/Questionnaire-title",
"type": "string",
"documentation": "The human-friendly name of the questionnaire"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/Questionnaire-version",
"type": "token",
"documentation": "The business version of the questionnaire"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/Questionnaire-url",
"type": "uri",
"documentation": "The uri that identifies the questionnaire"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Questionnaire-status",
"type": "token",
"documentation": "The current status of the questionnaire"
}
]
},
{
"type": "QuestionnaireResponse",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"QuestionnaireResponse.parent",
"QuestionnaireResponse.questionnaire",
"QuestionnaireResponse.based-on",
"QuestionnaireResponse.subject",
"QuestionnaireResponse.author",
"QuestionnaireResponse.patient",
"QuestionnaireResponse.context",
"QuestionnaireResponse.source"
],
"searchRevInclude": [
"ClinicalImpression.investigation",
"Consent.source",
"Observation.related-target"
],
"searchParam": [
{
"name": "authored",
"definition": "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-authored",
"type": "date",
"documentation": "When the questionnaire response was last changed"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-identifier",
"type": "token",
"documentation": "The unique identifier for the questionnaire response"
},
{
"name": "parent",
"definition": "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-parent",
"type": "reference",
"documentation": "Procedure or observation this questionnaire response was performed as a part of"
},
{
"name": "questionnaire",
"definition": "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-questionnaire",
"type": "reference",
"documentation": "The questionnaire the answers are provided for"
},
{
"name": "based-on",
"definition": "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-based-on",
"type": "reference",
"documentation": "Plan/proposal/order fulfilled by this questionnaire response"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-subject",
"type": "reference",
"documentation": "The subject of the questionnaire response"
},
{
"name": "author",
"definition": "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-author",
"type": "reference",
"documentation": "The author of the questionnaire response"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-patient",
"type": "reference",
"documentation": "The patient that is the subject of the questionnaire response"
},
{
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-context",
"type": "reference",
"documentation": "Encounter or episode associated with the questionnaire response"
},
{
"name": "source",
"definition": "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-source",
"type": "reference",
"documentation": "The individual providing the information reflected in the questionnaire respose"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-status",
"type": "token",
"documentation": "The status of the questionnaire response"
}
]
},
{
"type": "ReferralRequest",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/ReferralRequest"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"ReferralRequest.requester",
"ReferralRequest.replaces",
"ReferralRequest.subject",
"ReferralRequest.encounter",
"ReferralRequest.based-on",
"ReferralRequest.patient",
"ReferralRequest.recipient",
"ReferralRequest.context",
"ReferralRequest.definition"
],
"searchRevInclude": [
"Appointment.incomingreferral",
"CarePlan.activity-reference",
"ClinicalImpression.action",
"DiagnosticReport.based-on",
"Encounter.incomingreferral",
"EpisodeOfCare.incomingreferral",
"ImagingStudy.basedon",
"Observation.based-on",
"Procedure.based-on",
"QuestionnaireResponse.based-on",
"ReferralRequest.replaces",
"ReferralRequest.based-on"
],
"searchParam": [
{
"name": "requester",
"definition": "http://hl7.org/fhir/SearchParameter/ReferralRequest-requester",
"type": "reference",
"documentation": "Individual making the request"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/ReferralRequest-identifier",
"type": "token",
"documentation": "Business identifier"
},
{
"name": "specialty",
"definition": "http://hl7.org/fhir/SearchParameter/ReferralRequest-specialty",
"type": "token",
"documentation": "The specialty that the referral is for"
},
{
"name": "replaces",
"definition": "http://hl7.org/fhir/SearchParameter/ReferralRequest-replaces",
"type": "reference",
"documentation": "Request(s) replaced by this request"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/ReferralRequest-subject",
"type": "reference",
"documentation": "Patient referred to care or transfer"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/ReferralRequest-encounter",
"type": "reference",
"documentation": "Originating encounter"
},
{
"name": "authored-on",
"definition": "http://hl7.org/fhir/SearchParameter/ReferralRequest-authored-on",
"type": "date",
"documentation": "Creation or activation date"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-type",
"type": "token",
"documentation": "The type of the referral"
},
{
"name": "priority",
"definition": "http://hl7.org/fhir/SearchParameter/ReferralRequest-priority",
"type": "token",
"documentation": "The priority assigned to the referral"
},
{
"name": "intent",
"definition": "http://hl7.org/fhir/SearchParameter/ReferralRequest-intent",
"type": "token",
"documentation": "Proposal, plan or order"
},
{
"name": "group-identifier",
"definition": "http://hl7.org/fhir/SearchParameter/ReferralRequest-group-identifier",
"type": "token",
"documentation": "Part of common request"
},
{
"name": "based-on",
"definition": "http://hl7.org/fhir/SearchParameter/ReferralRequest-based-on",
"type": "reference",
"documentation": "Request being fulfilled"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Who the referral is about"
},
{
"name": "service",
"definition": "http://hl7.org/fhir/SearchParameter/ReferralRequest-service",
"type": "token",
"documentation": "Actions requested as part of the referral"
},
{
"name": "occurrence-date",
"definition": "http://hl7.org/fhir/SearchParameter/ReferralRequest-occurrence-date",
"type": "date",
"documentation": "When the service(s) requested in the referral should occur"
},
{
"name": "recipient",
"definition": "http://hl7.org/fhir/SearchParameter/ReferralRequest-recipient",
"type": "reference",
"documentation": "The person that the referral was sent to"
},
{
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/ReferralRequest-context",
"type": "reference",
"documentation": "Part of encounter or episode of care"
},
{
"name": "definition",
"definition": "http://hl7.org/fhir/SearchParameter/ReferralRequest-definition",
"type": "reference",
"documentation": "Instantiates protocol or definition"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/ReferralRequest-status",
"type": "token",
"documentation": "The status of the referral"
}
]
},
{
"type": "RelatedPerson",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"RelatedPerson.patient"
],
"searchRevInclude": [
"AdverseEvent.recorder",
"AllergyIntolerance.asserter",
"Appointment.actor",
"Appointment.practitioner",
"Appointment.patient",
"Appointment.location",
"AppointmentResponse.actor",
"AppointmentResponse.practitioner",
"AppointmentResponse.patient",
"AppointmentResponse.location",
"AuditEvent.agent",
"AuditEvent.patient",
"Basic.author",
"CarePlan.performer",
"CareTeam.participant",
"ChargeItem.participant-actor",
"ChargeItem.enterer",
"Claim.payee",
"Communication.sender",
"Communication.recipient",
"CommunicationRequest.requester",
"CommunicationRequest.sender",
"CommunicationRequest.recipient",
"Composition.author",
"Condition.asserter",
"Consent.actor",
"Consent.consentor",
"Contract.agent",
"Contract.signer",
"Coverage.subscriber",
"Coverage.payor",
"Coverage.policy-holder",
"DeviceRequest.performer",
"DocumentManifest.author",
"DocumentManifest.recipient",
"DocumentReference.author",
"Encounter.practitioner",
"Encounter.participant",
"ExplanationOfBenefit.payee",
"ImagingManifest.author",
"MedicationAdministration.performer",
"MedicationDispense.performer",
"MedicationRequest.requester",
"MedicationStatement.source",
"Observation.performer",
"Patient.link",
"Person.practitioner",
"Person.link",
"Person.relatedperson",
"Person.patient",
"Procedure.performer",
"ProcedureRequest.performer",
"Provenance.agent",
"QuestionnaireResponse.author",
"QuestionnaireResponse.source",
"ReferralRequest.requester",
"RequestGroup.participant",
"Schedule.actor",
"SupplyRequest.requester",
"Task.owner",
"Task.requester"
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/RelatedPerson-identifier",
"type": "token",
"documentation": "An Identifier of the RelatedPerson"
},
{
"name": "address",
"definition": "http://hl7.org/fhir/SearchParameter/individual-address",
"type": "string",
"documentation": "A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text"
},
{
"name": "birthdate",
"definition": "http://hl7.org/fhir/SearchParameter/individual-birthdate",
"type": "date",
"documentation": "The Related Person's date of birth"
},
{
"name": "address-state",
"definition": "http://hl7.org/fhir/SearchParameter/individual-address-state",
"type": "string",
"documentation": "A state specified in an address"
},
{
"name": "gender",
"definition": "http://hl7.org/fhir/SearchParameter/individual-gender",
"type": "token",
"documentation": "Gender of the related person"
},
{
"name": "active",
"definition": "http://hl7.org/fhir/SearchParameter/RelatedPerson-active",
"type": "token",
"documentation": "Indicates if the related person record is active"
},
{
"name": "address-postalcode",
"definition": "http://hl7.org/fhir/SearchParameter/individual-address-postalcode",
"type": "string",
"documentation": "A postal code specified in an address"
},
{
"name": "address-country",
"definition": "http://hl7.org/fhir/SearchParameter/individual-address-country",
"type": "string",
"documentation": "A country specified in an address"
},
{
"name": "phonetic",
"definition": "http://hl7.org/fhir/SearchParameter/individual-phonetic",
"type": "string",
"documentation": "A portion of name using some kind of phonetic matching algorithm"
},
{
"name": "phone",
"definition": "http://hl7.org/fhir/SearchParameter/individual-phone",
"type": "token",
"documentation": "A value in a phone contact"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/RelatedPerson-patient",
"type": "reference",
"documentation": "The patient this related person is related to"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/RelatedPerson-name",
"type": "string",
"documentation": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text"
},
{
"name": "address-use",
"definition": "http://hl7.org/fhir/SearchParameter/individual-address-use",
"type": "token",
"documentation": "A use code specified in an address"
},
{
"name": "telecom",
"definition": "http://hl7.org/fhir/SearchParameter/individual-telecom",
"type": "token",
"documentation": "The value in any kind of contact"
},
{
"name": "address-city",
"definition": "http://hl7.org/fhir/SearchParameter/individual-address-city",
"type": "string",
"documentation": "A city specified in an address"
},
{
"name": "email",
"definition": "http://hl7.org/fhir/SearchParameter/individual-email",
"type": "token",
"documentation": "A value in an email contact"
}
]
},
{
"type": "RequestGroup",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/RequestGroup"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"RequestGroup.subject",
"RequestGroup.author",
"RequestGroup.encounter",
"RequestGroup.participant",
"RequestGroup.patient",
"RequestGroup.context",
"RequestGroup.definition"
],
"searchRevInclude": [
"CarePlan.activity-reference"
],
"searchParam": [
{
"name": "authored",
"definition": "http://hl7.org/fhir/SearchParameter/RequestGroup-authored",
"type": "date",
"documentation": "The date the request group was authored"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/RequestGroup-identifier",
"type": "token",
"documentation": "External identifiers for the request group"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/RequestGroup-subject",
"type": "reference",
"documentation": "The subject that the request group is about"
},
{
"name": "author",
"definition": "http://hl7.org/fhir/SearchParameter/RequestGroup-author",
"type": "reference",
"documentation": "The author of the request group"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/RequestGroup-encounter",
"type": "reference",
"documentation": "The encounter the request group applies to"
},
{
"name": "priority",
"definition": "http://hl7.org/fhir/SearchParameter/RequestGroup-priority",
"type": "token",
"documentation": "The priority of the request group"
},
{
"name": "intent",
"definition": "http://hl7.org/fhir/SearchParameter/RequestGroup-intent",
"type": "token",
"documentation": "The intent of the request group"
},
{
"name": "participant",
"definition": "http://hl7.org/fhir/SearchParameter/RequestGroup-participant",
"type": "reference",
"documentation": "The participant in the requests in the group"
},
{
"name": "group-identifier",
"definition": "http://hl7.org/fhir/SearchParameter/RequestGroup-group-identifier",
"type": "token",
"documentation": "The group identifier for the request group"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/RequestGroup-patient",
"type": "reference",
"documentation": "The identity of a patient to search for request groups"
},
{
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/RequestGroup-context",
"type": "reference",
"documentation": "The context the request group applies to"
},
{
"name": "definition",
"definition": "http://hl7.org/fhir/SearchParameter/RequestGroup-definition",
"type": "reference",
"documentation": "The definition from which the request group is realized"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/RequestGroup-status",
"type": "token",
"documentation": "The status of the request group"
}
]
},
{
"type": "ResearchStudy",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/ResearchStudy"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"ResearchStudy.partof",
"ResearchStudy.sponsor",
"ResearchStudy.principalinvestigator",
"ResearchStudy.protocol",
"ResearchStudy.site"
],
"searchRevInclude": [
"AdverseEvent.study",
"ResearchStudy.partof"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/ResearchStudy-date",
"type": "date",
"documentation": "When the study began and ended"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/ResearchStudy-identifier",
"type": "token",
"documentation": "Business Identifier for study"
},
{
"name": "partof",
"definition": "http://hl7.org/fhir/SearchParameter/ResearchStudy-partof",
"type": "reference",
"documentation": "Part of larger study"
},
{
"name": "sponsor",
"definition": "http://hl7.org/fhir/SearchParameter/ResearchStudy-sponsor",
"type": "reference",
"documentation": "Organization responsible for the study"
},
{
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/ResearchStudy-jurisdiction",
"type": "token",
"documentation": "Geographic region(s) for study"
},
{
"name": "focus",
"definition": "http://hl7.org/fhir/SearchParameter/ResearchStudy-focus",
"type": "token",
"documentation": "Drugs, devices, conditions, etc. under study"
},
{
"name": "principalinvestigator",
"definition": "http://hl7.org/fhir/SearchParameter/ResearchStudy-principalinvestigator",
"type": "reference",
"documentation": "The individual responsible for the study"
},
{
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/ResearchStudy-title",
"type": "string",
"documentation": "Name for this study"
},
{
"name": "protocol",
"definition": "http://hl7.org/fhir/SearchParameter/ResearchStudy-protocol",
"type": "reference",
"documentation": "Steps followed in executing study"
},
{
"name": "site",
"definition": "http://hl7.org/fhir/SearchParameter/ResearchStudy-site",
"type": "reference",
"documentation": "Location involved in study execution"
},
{
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/ResearchStudy-category",
"type": "token",
"documentation": "Classifications for the study"
},
{
"name": "keyword",
"definition": "http://hl7.org/fhir/SearchParameter/ResearchStudy-keyword",
"type": "token",
"documentation": "Used to search for the study"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/ResearchStudy-status",
"type": "token",
"documentation": "draft | in-progress | suspended | stopped | completed | entered-in-error"
}
]
},
{
"type": "ResearchSubject",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/ResearchSubject"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"ResearchSubject.individual",
"ResearchSubject.patient"
],
"searchRevInclude": [
"AdverseEvent.subject"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/ResearchSubject-date",
"type": "date",
"documentation": "Start and end of participation"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/ResearchSubject-identifier",
"type": "token",
"documentation": "Business Identifier for research subject"
},
{
"name": "individual",
"definition": "http://hl7.org/fhir/SearchParameter/ResearchSubject-individual",
"type": "reference",
"documentation": "Who is part of study"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/ResearchSubject-patient",
"type": "reference",
"documentation": "Who is part of study"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/ResearchSubject-status",
"type": "token",
"documentation": "candidate | enrolled | active | suspended | withdrawn | completed"
}
]
},
{
"type": "RiskAssessment",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/RiskAssessment"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"RiskAssessment.condition",
"RiskAssessment.performer",
"RiskAssessment.subject",
"RiskAssessment.patient",
"RiskAssessment.encounter"
],
"searchRevInclude": [
"ClinicalImpression.investigation"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"type": "date",
"documentation": "When was assessment made?"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "Unique identifier for the assessment"
},
{
"name": "condition",
"definition": "http://hl7.org/fhir/SearchParameter/RiskAssessment-condition",
"type": "reference",
"documentation": "Condition assessed"
},
{
"name": "performer",
"definition": "http://hl7.org/fhir/SearchParameter/RiskAssessment-performer",
"type": "reference",
"documentation": "Who did assessment?"
},
{
"name": "method",
"definition": "http://hl7.org/fhir/SearchParameter/RiskAssessment-method",
"type": "token",
"documentation": "Evaluation mechanism"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/RiskAssessment-subject",
"type": "reference",
"documentation": "Who/what does assessment apply to?"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Who/what does assessment apply to?"
},
{
"name": "probability",
"definition": "http://hl7.org/fhir/SearchParameter/RiskAssessment-probability",
"type": "number",
"documentation": "Likelihood of specified outcome"
},
{
"name": "risk",
"definition": "http://hl7.org/fhir/SearchParameter/RiskAssessment-risk",
"type": "token",
"documentation": "Likelihood of specified outcome as a qualitative value"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"type": "reference",
"documentation": "Where was assessment performed?"
}
]
},
{
"type": "Schedule",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Schedule"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Schedule.actor"
],
"searchRevInclude": [
"Slot.schedule"
],
"searchParam": [
{
"name": "actor",
"definition": "http://hl7.org/fhir/SearchParameter/Schedule-actor",
"type": "reference",
"documentation": "The individual(HealthcareService, Practitioner, Location, ...) to find a Schedule for"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/Schedule-date",
"type": "date",
"documentation": "Search for Schedule resources that have a period that contains this date specified"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Schedule-identifier",
"type": "token",
"documentation": "A Schedule Identifier"
},
{
"name": "active",
"definition": "http://hl7.org/fhir/SearchParameter/Schedule-active",
"type": "token",
"documentation": "Is the schedule in active use"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/Schedule-type",
"type": "token",
"documentation": "The type of appointments that can be booked into associated slot(s)"
}
]
},
{
"type": "SearchParameter",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/SearchParameter"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"SearchParameter.component"
],
"searchRevInclude": [
"SearchParameter.component"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/SearchParameter-date",
"type": "date",
"documentation": "The search parameter publication date"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/SearchParameter-code",
"type": "token",
"documentation": "Code used in URL"
},
{
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/SearchParameter-jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the search parameter"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/SearchParameter-description",
"type": "string",
"documentation": "The description of the search parameter"
},
{
"name": "derived-from",
"definition": "http://hl7.org/fhir/SearchParameter/SearchParameter-derived-from",
"type": "uri",
"documentation": "Original Definition for the search parameter"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/SearchParameter-type",
"type": "token",
"documentation": "number | date | string | token | reference | composite | quantity | uri"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/SearchParameter-version",
"type": "token",
"documentation": "The business version of the search parameter"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/SearchParameter-url",
"type": "uri",
"documentation": "The uri that identifies the search parameter"
},
{
"name": "target",
"definition": "http://hl7.org/fhir/SearchParameter/SearchParameter-target",
"type": "token",
"documentation": "Types of resource (if a resource reference)"
},
{
"name": "component",
"definition": "http://hl7.org/fhir/SearchParameter/SearchParameter-component",
"type": "reference",
"documentation": "Defines how the part works"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/SearchParameter-name",
"type": "string",
"documentation": "Computationally friendly name of the search parameter"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/SearchParameter-publisher",
"type": "string",
"documentation": "Name of the publisher of the search parameter"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/SearchParameter-status",
"type": "token",
"documentation": "The current status of the search parameter"
},
{
"name": "base",
"definition": "http://hl7.org/fhir/SearchParameter/SearchParameter-base",
"type": "token",
"documentation": "The resource type(s) this search parameter applies to"
}
]
},
{
"type": "Sequence",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Sequence"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Sequence.patient"
],
"searchRevInclude": [
"Observation.related-target"
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Sequence-identifier",
"type": "token",
"documentation": "The unique identity for a particular sequence"
},
{
"name": "coordinate",
"definition": "http://hl7.org/fhir/SearchParameter/Sequence-coordinate",
"type": "composite",
"documentation": "Search parameter for region of the reference DNA sequence string. This will refer to part of a locus or part of a gene where search region will be represented in 1-based system. Since the coordinateSystem can either be 0-based or 1-based, this search query will include the result of both coordinateSystem that contains the equivalent segment of the gene or whole genome sequence. For example, a search for sequence can be represented as `coordinate=1$lt345$gt123`, this means it will search for the Sequence resource on chromosome 1 and with position >123 and <345, where in 1-based system resource, all strings within region 1:124-344 will be revealed, while in 0-based system resource, all strings within region 1:123-344 will be revealed. You may want to check detail about 0-based v.s. 1-based above."
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/Sequence-patient",
"type": "reference",
"documentation": "The subject that the observation is about"
},
{
"name": "chromosome",
"definition": "http://hl7.org/fhir/SearchParameter/Sequence-chromosome",
"type": "token",
"documentation": "Chromosome number of the reference sequence"
},
{
"name": "start",
"definition": "http://hl7.org/fhir/SearchParameter/Sequence-start",
"type": "number",
"documentation": "Start position (0-based inclusive, 1-based inclusive, that means the nucleic acid or amino acid at this position will be included) of the reference sequence."
},
{
"name": "end",
"definition": "http://hl7.org/fhir/SearchParameter/Sequence-end",
"type": "number",
"documentation": "End position (0-based exclusive, which menas the acid at this position will not be included, 1-based inclusive, which means the acid at this position will be included) of the reference sequence."
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/Sequence-type",
"type": "token",
"documentation": "Amino Acid Sequence/ DNA Sequence / RNA Sequence"
}
]
},
{
"type": "ServiceDefinition",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/ServiceDefinition"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"ServiceDefinition.successor",
"ServiceDefinition.derived-from",
"ServiceDefinition.predecessor",
"ServiceDefinition.composed-of",
"ServiceDefinition.depends-on"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/ServiceDefinition-date",
"type": "date",
"documentation": "The service definition publication date"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/ServiceDefinition-identifier",
"type": "token",
"documentation": "External identifier for the service definition"
},
{
"name": "successor",
"definition": "http://hl7.org/fhir/SearchParameter/ServiceDefinition-successor",
"type": "reference",
"documentation": "What resource is being referenced"
},
{
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/ServiceDefinition-jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the service definition"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/ServiceDefinition-description",
"type": "string",
"documentation": "The description of the service definition"
},
{
"name": "derived-from",
"definition": "http://hl7.org/fhir/SearchParameter/ServiceDefinition-derived-from",
"type": "reference",
"documentation": "What resource is being referenced"
},
{
"name": "predecessor",
"definition": "http://hl7.org/fhir/SearchParameter/ServiceDefinition-predecessor",
"type": "reference",
"documentation": "What resource is being referenced"
},
{
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/ServiceDefinition-title",
"type": "string",
"documentation": "The human-friendly name of the service definition"
},
{
"name": "composed-of",
"definition": "http://hl7.org/fhir/SearchParameter/ServiceDefinition-composed-of",
"type": "reference",
"documentation": "What resource is being referenced"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/ServiceDefinition-version",
"type": "token",
"documentation": "The business version of the service definition"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/ServiceDefinition-url",
"type": "uri",
"documentation": "The uri that identifies the service definition"
},
{
"name": "effective",
"definition": "http://hl7.org/fhir/SearchParameter/ServiceDefinition-effective",
"type": "date",
"documentation": "The time during which the service definition is intended to be in use"
},
{
"name": "depends-on",
"definition": "http://hl7.org/fhir/SearchParameter/ServiceDefinition-depends-on",
"type": "reference",
"documentation": "What resource is being referenced"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/ServiceDefinition-name",
"type": "string",
"documentation": "Computationally friendly name of the service definition"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/ServiceDefinition-publisher",
"type": "string",
"documentation": "Name of the publisher of the service definition"
},
{
"name": "topic",
"definition": "http://hl7.org/fhir/SearchParameter/ServiceDefinition-topic",
"type": "token",
"documentation": "Topics associated with the module"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/ServiceDefinition-status",
"type": "token",
"documentation": "The current status of the service definition"
}
]
},
{
"type": "Slot",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Slot"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Slot.schedule"
],
"searchParam": [
{
"name": "schedule",
"definition": "http://hl7.org/fhir/SearchParameter/Slot-schedule",
"type": "reference",
"documentation": "The Schedule Resource that we are seeking a slot within"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Slot-identifier",
"type": "token",
"documentation": "A Slot Identifier"
},
{
"name": "start",
"definition": "http://hl7.org/fhir/SearchParameter/Slot-start",
"type": "date",
"documentation": "Appointment date/time."
},
{
"name": "slot-type",
"definition": "http://hl7.org/fhir/SearchParameter/Slot-slot-type",
"type": "token",
"documentation": "The type of appointments that can be booked into the slot"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Slot-status",
"type": "token",
"documentation": "The free/busy status of the appointment"
}
]
},
{
"type": "Specimen",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Specimen"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Specimen.parent",
"Specimen.subject",
"Specimen.patient",
"Specimen.collector"
],
"searchRevInclude": [
"DiagnosticReport.specimen",
"Media.subject",
"Media.patient",
"Observation.specimen",
"ProcedureRequest.specimen",
"Specimen.parent"
],
"searchParam": [
{
"name": "container",
"definition": "http://hl7.org/fhir/SearchParameter/Specimen-container",
"type": "token",
"documentation": "The kind of specimen container"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Specimen-identifier",
"type": "token",
"documentation": "The unique identifier associated with the specimen"
},
{
"name": "parent",
"definition": "http://hl7.org/fhir/SearchParameter/Specimen-parent",
"type": "reference",
"documentation": "The parent of the specimen"
},
{
"name": "container-id",
"definition": "http://hl7.org/fhir/SearchParameter/Specimen-container-id",
"type": "token",
"documentation": "The unique identifier associated with the specimen container"
},
{
"name": "bodysite",
"definition": "http://hl7.org/fhir/SearchParameter/Specimen-bodysite",
"type": "token",
"documentation": "The code for the body site from where the specimen originated"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/Specimen-subject",
"type": "reference",
"documentation": "The subject of the specimen"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/Specimen-patient",
"type": "reference",
"documentation": "The patient the specimen comes from"
},
{
"name": "collected",
"definition": "http://hl7.org/fhir/SearchParameter/Specimen-collected",
"type": "date",
"documentation": "The date the specimen was collected"
},
{
"name": "accession",
"definition": "http://hl7.org/fhir/SearchParameter/Specimen-accession",
"type": "token",
"documentation": "The accession number associated with the specimen"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/Specimen-type",
"type": "token",
"documentation": "The specimen type"
},
{
"name": "collector",
"definition": "http://hl7.org/fhir/SearchParameter/Specimen-collector",
"type": "reference",
"documentation": "Who collected the specimen"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Specimen-status",
"type": "token",
"documentation": "available | unavailable | unsatisfactory | entered-in-error"
}
]
},
{
"type": "StructureDefinition",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/StructureDefinition"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"StructureDefinition.valueset"
],
"searchRevInclude": [
"CapabilityStatement.resource-profile",
"CapabilityStatement.supported-profile",
"OperationDefinition.param-profile"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/StructureDefinition-date",
"type": "date",
"documentation": "The structure definition publication date"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/StructureDefinition-identifier",
"type": "token",
"documentation": "External identifier for the structure definition"
},
{
"name": "valueset",
"definition": "http://hl7.org/fhir/SearchParameter/StructureDefinition-valueset",
"type": "reference",
"documentation": "A vocabulary binding reference"
},
{
"name": "kind",
"definition": "http://hl7.org/fhir/SearchParameter/StructureDefinition-kind",
"type": "token",
"documentation": "primitive-type | complex-type | resource | logical"
},
{
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/StructureDefinition-jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the structure definition"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/StructureDefinition-description",
"type": "string",
"documentation": "The description of the structure definition"
},
{
"name": "experimental",
"definition": "http://hl7.org/fhir/SearchParameter/StructureDefinition-experimental",
"type": "token",
"documentation": "For testing purposes, not real usage"
},
{
"name": "context-type",
"definition": "http://hl7.org/fhir/SearchParameter/StructureDefinition-context-type",
"type": "token",
"documentation": "resource | datatype | extension"
},
{
"name": "abstract",
"definition": "http://hl7.org/fhir/SearchParameter/StructureDefinition-abstract",
"type": "token",
"documentation": "Whether the structure is abstract"
},
{
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/StructureDefinition-title",
"type": "string",
"documentation": "The human-friendly name of the structure definition"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/StructureDefinition-type",
"type": "token",
"documentation": "Type defined or constrained by this structure"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/StructureDefinition-version",
"type": "token",
"documentation": "The business version of the structure definition"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/StructureDefinition-url",
"type": "uri",
"documentation": "The uri that identifies the structure definition"
},
{
"name": "path",
"definition": "http://hl7.org/fhir/SearchParameter/StructureDefinition-path",
"type": "token",
"documentation": "A path that is constrained in the profile"
},
{
"name": "ext-context",
"definition": "http://hl7.org/fhir/SearchParameter/StructureDefinition-ext-context",
"type": "string",
"documentation": "Where the extension can be used in instances"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/StructureDefinition-name",
"type": "string",
"documentation": "Computationally friendly name of the structure definition"
},
{
"name": "base-path",
"definition": "http://hl7.org/fhir/SearchParameter/StructureDefinition-base-path",
"type": "token",
"documentation": "Path that identifies the base element"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/StructureDefinition-publisher",
"type": "string",
"documentation": "Name of the publisher of the structure definition"
},
{
"name": "derivation",
"definition": "http://hl7.org/fhir/SearchParameter/StructureDefinition-derivation",
"type": "token",
"documentation": "specialization | constraint - How relates to base definition"
},
{
"name": "keyword",
"definition": "http://hl7.org/fhir/SearchParameter/StructureDefinition-keyword",
"type": "token",
"documentation": "A code for the profile"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/StructureDefinition-status",
"type": "token",
"documentation": "The current status of the structure definition"
},
{
"name": "base",
"definition": "http://hl7.org/fhir/SearchParameter/StructureDefinition-base",
"type": "uri",
"documentation": "Definition that this type is constrained/specialized from"
}
]
},
{
"type": "StructureMap",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/StructureMap"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/StructureMap-date",
"type": "date",
"documentation": "The structure map publication date"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/StructureMap-identifier",
"type": "token",
"documentation": "External identifier for the structure map"
},
{
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/StructureMap-jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the structure map"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/StructureMap-name",
"type": "string",
"documentation": "Computationally friendly name of the structure map"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/StructureMap-description",
"type": "string",
"documentation": "The description of the structure map"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/StructureMap-publisher",
"type": "string",
"documentation": "Name of the publisher of the structure map"
},
{
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/StructureMap-title",
"type": "string",
"documentation": "The human-friendly name of the structure map"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/StructureMap-version",
"type": "token",
"documentation": "The business version of the structure map"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/StructureMap-url",
"type": "uri",
"documentation": "The uri that identifies the structure map"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/StructureMap-status",
"type": "token",
"documentation": "The current status of the structure map"
}
]
},
{
"type": "Subscription",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Subscription"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchParam": [
{
"name": "payload",
"definition": "http://hl7.org/fhir/SearchParameter/Subscription-payload",
"type": "string",
"documentation": "The mime-type of the notification payload"
},
{
"name": "criteria",
"definition": "http://hl7.org/fhir/SearchParameter/Subscription-criteria",
"type": "string",
"documentation": "The search rules used to determine when to send a notification"
},
{
"name": "add-tag",
"definition": "http://hl7.org/fhir/SearchParameter/Subscription-add-tag",
"type": "token",
"documentation": "A tag to be added to the resource matching the criteria"
},
{
"name": "contact",
"definition": "http://hl7.org/fhir/SearchParameter/Subscription-contact",
"type": "token",
"documentation": "Contact details for the subscription"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/Subscription-type",
"type": "token",
"documentation": "The type of channel for the sent notifications"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/Subscription-url",
"type": "uri",
"documentation": "The uri that will receive the notifications"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Subscription-status",
"type": "token",
"documentation": "The current state of the subscription"
}
]
},
{
"type": "Substance",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Substance"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Substance.substance-reference"
],
"searchRevInclude": [
"AdverseEvent.substance",
"Contract.agent",
"Group.member",
"Medication.ingredient",
"Specimen.subject",
"Specimen.patient",
"Substance.substance-reference"
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Substance-identifier",
"type": "token",
"documentation": "Unique identifier for the substance"
},
{
"name": "container-identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Substance-container-identifier",
"type": "token",
"documentation": "Identifier of the package/container"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/Substance-code",
"type": "token",
"documentation": "The code of the substance or ingredient"
},
{
"name": "quantity",
"definition": "http://hl7.org/fhir/SearchParameter/Substance-quantity",
"type": "quantity",
"documentation": "Amount of substance in the package"
},
{
"name": "substance-reference",
"definition": "http://hl7.org/fhir/SearchParameter/Substance-substance-reference",
"type": "reference",
"documentation": "A component of the substance"
},
{
"name": "expiry",
"definition": "http://hl7.org/fhir/SearchParameter/Substance-expiry",
"type": "date",
"documentation": "Expiry date of package or container of substance"
},
{
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/Substance-category",
"type": "token",
"documentation": "The category of the substance"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Substance-status",
"type": "token",
"documentation": "active | inactive | entered-in-error"
}
]
},
{
"type": "SupplyDelivery",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/SupplyDelivery"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"SupplyDelivery.receiver",
"SupplyDelivery.patient",
"SupplyDelivery.supplier"
],
"searchRevInclude": [
"ChargeItem.service"
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "External identifier"
},
{
"name": "receiver",
"definition": "http://hl7.org/fhir/SearchParameter/SupplyDelivery-receiver",
"type": "reference",
"documentation": "Who collected the Supply"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Patient for whom the item is supplied"
},
{
"name": "supplier",
"definition": "http://hl7.org/fhir/SearchParameter/SupplyDelivery-supplier",
"type": "reference",
"documentation": "Dispenser"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/SupplyDelivery-status",
"type": "token",
"documentation": "in-progress | completed | abandoned | entered-in-error"
}
]
},
{
"type": "SupplyRequest",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/SupplyRequest"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"SupplyRequest.requester",
"SupplyRequest.supplier"
],
"searchParam": [
{
"name": "requester",
"definition": "http://hl7.org/fhir/SearchParameter/SupplyRequest-requester",
"type": "reference",
"documentation": "Individual making the request"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"type": "date",
"documentation": "When the request was made"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "Unique identifier"
},
{
"name": "supplier",
"definition": "http://hl7.org/fhir/SearchParameter/SupplyRequest-supplier",
"type": "reference",
"documentation": "Who is intended to fulfill the request"
},
{
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/SupplyRequest-category",
"type": "token",
"documentation": "The kind of supply (central, non-stock, etc.)"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/SupplyRequest-status",
"type": "token",
"documentation": "draft | active | suspended +"
}
]
},
{
"type": "Task",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/Task"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"Task.owner",
"Task.requester",
"Task.subject",
"Task.focus",
"Task.part-of",
"Task.based-on",
"Task.patient",
"Task.organization",
"Task.context"
],
"searchRevInclude": [
"CarePlan.activity-reference",
"Task.part-of"
],
"searchParam": [
{
"name": "owner",
"definition": "http://hl7.org/fhir/SearchParameter/Task-owner",
"type": "reference",
"documentation": "Search by task owner"
},
{
"name": "requester",
"definition": "http://hl7.org/fhir/SearchParameter/Task-requester",
"type": "reference",
"documentation": "Search by task requester"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Task-identifier",
"type": "token",
"documentation": "Search for a task instance by its business identifier"
},
{
"name": "business-status",
"definition": "http://hl7.org/fhir/SearchParameter/Task-business-status",
"type": "token",
"documentation": "Search by business status"
},
{
"name": "period",
"definition": "http://hl7.org/fhir/SearchParameter/Task-period",
"type": "date",
"documentation": "Search by period Task is/was underway"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/Task-code",
"type": "token",
"documentation": "Search by task code"
},
{
"name": "performer",
"definition": "http://hl7.org/fhir/SearchParameter/Task-performer",
"type": "token",
"documentation": "Search by recommended type of performer (e.g., Requester, Performer, Scheduler)."
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/Task-subject",
"type": "reference",
"documentation": "Search by subject"
},
{
"name": "focus",
"definition": "http://hl7.org/fhir/SearchParameter/Task-focus",
"type": "reference",
"documentation": "Search by task focus"
},
{
"name": "part-of",
"definition": "http://hl7.org/fhir/SearchParameter/Task-part-of",
"type": "reference",
"documentation": "Search by task this task is part of"
},
{
"name": "priority",
"definition": "http://hl7.org/fhir/SearchParameter/Task-priority",
"type": "token",
"documentation": "Search by task priority"
},
{
"name": "authored-on",
"definition": "http://hl7.org/fhir/SearchParameter/Task-authored-on",
"type": "date",
"documentation": "Search by creation date"
},
{
"name": "intent",
"definition": "http://hl7.org/fhir/SearchParameter/Task-intent",
"type": "token",
"documentation": "Search by task intent"
},
{
"name": "group-identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Task-group-identifier",
"type": "token",
"documentation": "Search by group identifier"
},
{
"name": "based-on",
"definition": "http://hl7.org/fhir/SearchParameter/Task-based-on",
"type": "reference",
"documentation": "Search by requests this task is based on"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/Task-patient",
"type": "reference",
"documentation": "Search by patient"
},
{
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/Task-organization",
"type": "reference",
"documentation": "Search by responsible organization"
},
{
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/Task-context",
"type": "reference",
"documentation": "Search by encounter or episode"
},
{
"name": "modified",
"definition": "http://hl7.org/fhir/SearchParameter/Task-modified",
"type": "date",
"documentation": "Search by last modification date"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Task-status",
"type": "token",
"documentation": "Search by task status"
}
]
},
{
"type": "TestReport",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/TestReport"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"TestReport.testscript"
],
"searchParam": [
{
"name": "result",
"definition": "http://hl7.org/fhir/SearchParameter/TestReport-result",
"type": "token",
"documentation": "The result disposition of the test execution"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/TestReport-identifier",
"type": "token",
"documentation": "An external identifier for the test report"
},
{
"name": "tester",
"definition": "http://hl7.org/fhir/SearchParameter/TestReport-tester",
"type": "string",
"documentation": "The name of the testing organization"
},
{
"name": "testscript",
"definition": "http://hl7.org/fhir/SearchParameter/TestReport-testscript",
"type": "reference",
"documentation": "The test script executed to produce this report"
},
{
"name": "issued",
"definition": "http://hl7.org/fhir/SearchParameter/TestReport-issued",
"type": "date",
"documentation": "The test report generation date"
},
{
"name": "participant",
"definition": "http://hl7.org/fhir/SearchParameter/TestReport-participant",
"type": "uri",
"documentation": "The reference to a participant in the test execution"
}
]
},
{
"type": "TestScript",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/TestScript"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchRevInclude": [
"TestReport.testscript"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/TestScript-date",
"type": "date",
"documentation": "The test script publication date"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/TestScript-identifier",
"type": "token",
"documentation": "External identifier for the test script"
},
{
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/TestScript-jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the test script"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/TestScript-name",
"type": "string",
"documentation": "Computationally friendly name of the test script"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/TestScript-description",
"type": "string",
"documentation": "The description of the test script"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/TestScript-publisher",
"type": "string",
"documentation": "Name of the publisher of the test script"
},
{
"name": "testscript-capability",
"definition": "http://hl7.org/fhir/SearchParameter/TestScript-testscript-capability",
"type": "string",
"documentation": "TestScript required and validated capability"
},
{
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/TestScript-title",
"type": "string",
"documentation": "The human-friendly name of the test script"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/TestScript-version",
"type": "token",
"documentation": "The business version of the test script"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/TestScript-url",
"type": "uri",
"documentation": "The uri that identifies the test script"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/TestScript-status",
"type": "token",
"documentation": "The current status of the test script"
}
]
},
{
"type": "ValueSet",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/ValueSet"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchRevInclude": [
"ConceptMap.source",
"ConceptMap.target",
"ConceptMap.source-uri",
"ConceptMap.target-uri",
"StructureDefinition.valueset"
],
"searchParam": [
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/ValueSet-date",
"type": "date",
"documentation": "The value set publication date"
},
{
"name": "reference",
"definition": "http://hl7.org/fhir/SearchParameter/ValueSet-reference",
"type": "uri",
"documentation": "A code system included or excluded in the value set or an imported value set"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/ValueSet-identifier",
"type": "token",
"documentation": "External identifier for the value set"
},
{
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/ValueSet-jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the value set"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/ValueSet-name",
"type": "string",
"documentation": "Computationally friendly name of the value set"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/ValueSet-description",
"type": "string",
"documentation": "The description of the value set"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/ValueSet-publisher",
"type": "string",
"documentation": "Name of the publisher of the value set"
},
{
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/ValueSet-title",
"type": "string",
"documentation": "The human-friendly name of the value set"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/ValueSet-version",
"type": "token",
"documentation": "The business version of the value set"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/ValueSet-url",
"type": "uri",
"documentation": "The uri that identifies the value set"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/ValueSet-status",
"type": "token",
"documentation": "The current status of the value set"
},
{
"name": "expansion",
"definition": "http://hl7.org/fhir/SearchParameter/ValueSet-expansion",
"type": "uri",
"documentation": "Uniquely identifies this expansion"
}
]
},
{
"type": "VisionPrescription",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/VisionPrescription"
},
"interaction": [
{
"code": "read",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "vread",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "update",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "delete",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-instance",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "create",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"referencePolicy": [
"literal",
"logical"
],
"searchInclude": [
"VisionPrescription.prescriber",
"VisionPrescription.patient",
"VisionPrescription.encounter"
],
"searchRevInclude": [
"CarePlan.activity-reference"
],
"searchParam": [
{
"name": "prescriber",
"definition": "http://hl7.org/fhir/SearchParameter/VisionPrescription-prescriber",
"type": "reference",
"documentation": "Who authorizes the vision product"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "Return prescriptions with this external identifier"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "The identity of a patient to list dispenses for"
},
{
"name": "datewritten",
"definition": "http://hl7.org/fhir/SearchParameter/VisionPrescription-datewritten",
"type": "date",
"documentation": "Return prescriptions written on this date"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"type": "reference",
"documentation": "Return prescriptions with this encounter identifier"
}
]
}
],
"interaction": [
{
"code": "transaction",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "batch",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "history-system",
"documentation": "Implemented per the specification (or Insert other doco here)"
},
{
"code": "search-system",
"documentation": "Implemented per the specification (or Insert other doco here)"
}
],
"searchParam": [
{
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
},
{
"name": "_query",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-query",
"type": "token",
"documentation": "A custom search profile that describes a specific defined query operation"
},
{
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
},
{
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
},
{
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
},
{
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
},
{
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
},
{
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}
],
"operation": [
{
"name": "validate",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/resource-validate"
}
},
{
"name": "meta",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/resource-meta"
}
},
{
"name": "meta-add",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/resource-meta-add"
}
},
{
"name": "meta-delete",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/resource-meta-delete"
}
},
{
"name": "apply",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/activitydefinition-apply"
}
},
{
"name": "data-requirements",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/activitydefinition-data-requirements"
}
},
{
"name": "subset",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/capabilitystatement-subset"
}
},
{
"name": "implements",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/capabilitystatement-implements"
}
},
{
"name": "conforms",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/capabilitystatement-conforms"
}
},
{
"name": "lookup",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/codesystem-lookup"
}
},
{
"name": "subsumes",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/codesystem-subsumes"
}
},
{
"name": "compose",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/codesystem-compose"
}
},
{
"name": "document",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/composition-document"
}
},
{
"name": "translate",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/conceptmap-translate"
}
},
{
"name": "closure",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/conceptmap-closure"
}
},
{
"name": "everything",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/encounter-everything"
}
},
{
"name": "data-requirements",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/library-data-requirements"
}
},
{
"name": "find",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/list-find"
}
},
{
"name": "evaluate-measure",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/measure-evaluate-measure"
}
},
{
"name": "data-requirements",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/measure-data-requirements"
}
},
{
"name": "process-message",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/messageheader-process-message"
}
},
{
"name": "stats",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/observation-stats"
}
},
{
"name": "lastn",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/observation-lastn"
}
},
{
"name": "match",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/patient-match"
}
},
{
"name": "everything",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/patient-everything"
}
},
{
"name": "apply",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/plandefinition-apply"
}
},
{
"name": "data-requirements",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/plandefinition-data-requirements"
}
},
{
"name": "populate",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/questionnaire-populate"
}
},
{
"name": "populatehtml",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/questionnaire-populatehtml"
}
},
{
"name": "populatelink",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/questionnaire-populatelink"
}
},
{
"name": "evaluate",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/servicedefinition-evaluate"
}
},
{
"name": "data-requirements",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/servicedefinition-data-requirements"
}
},
{
"name": "questionnaire",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/structuredefinition-questionnaire"
}
},
{
"name": "transform",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/structuremap-transform"
}
},
{
"name": "expand",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/valueset-expand"
}
},
{
"name": "validate-code",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/valueset-validate-code"
}
}
]
}
]
}
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.
®© HL7.org 2011+. FHIR Release 3 (STU; v3.0.2-11200) generated on Thurs, Oct 24, 2019 11:53+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU2 |
|
Propose a change