2nd DSTU Draft For Comment
This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
Base Conformance Statement
{
"resourceType": "Conformance",
"id": "base",
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/Conformance/base",
"version": "0.4.0-4167",
"name": "Base FHIR Conformance Statement (Full)",
"publisher": "FHIR Project Team",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
}
],
"description": "This is the base conformance 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 conformance statements from",
"status": "draft",
"date": "2015-02-23T09:07:27+11:00",
"fhirVersion": "0.4.0",
"acceptUnknown": false,
"format": [
"xml",
"json"
],
"rest": [
{
"mode": "server",
"documentation": "All the functionality defined in FHIR",
"resource": [
{
"type": "Alert",
"profile": {
"reference": "http://hl7.org/fhir/Alert"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/alert-patient",
"type": "reference",
"documentation": "The identity of a subject to list alerts for"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/alert-subject",
"type": "reference",
"documentation": "The identity of a subject to list alerts for"
}
]
},
{
"type": "AllergyIntolerance",
"profile": {
"reference": "http://hl7.org/fhir/AllergyIntolerance"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/allergyintolerance-status",
"type": "token",
"documentation": "unconfirmed | confirmed | resolved | refuted"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/allergyintolerance-subject",
"type": "reference",
"documentation": "Who the sensitivity is for"
},
{
"name": "onset",
"definition": "http://hl7.org/fhir/SearchParameter/allergyintolerance-onset",
"type": "date",
"documentation": "Date(/time) when manifestations showed"
},
{
"name": "last-date",
"definition": "http://hl7.org/fhir/SearchParameter/allergyintolerance-last-date",
"type": "date",
"documentation": "Date(/time) of last known occurence of a reaction"
},
{
"name": "severity",
"definition": "http://hl7.org/fhir/SearchParameter/allergyintolerance-severity",
"type": "token",
"documentation": "mild | moderate | severe (of event as a whole)"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/allergyintolerance-type",
"type": "token",
"documentation": "immune | non-immune - Underlying mechanism (if known)"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/allergyintolerance-date",
"type": "date",
"documentation": "When recorded"
},
{
"name": "substance",
"definition": "http://hl7.org/fhir/SearchParameter/allergyintolerance-substance",
"type": "token",
"documentation": "Substance, (or class) considered to be responsible for risk"
},
{
"name": "criticality",
"definition": "http://hl7.org/fhir/SearchParameter/allergyintolerance-criticality",
"type": "token",
"documentation": "low | high | unassessible - Estimated potential clinical harm"
},
{
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/allergyintolerance-category",
"type": "token",
"documentation": "food | medication | environment - Category of Substance"
},
{
"name": "duration",
"definition": "http://hl7.org/fhir/SearchParameter/allergyintolerance-duration",
"type": "quantity",
"documentation": "How long Manifestations persisted"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/allergyintolerance-patient",
"type": "reference",
"documentation": "Who the sensitivity is for"
},
{
"name": "recorder",
"definition": "http://hl7.org/fhir/SearchParameter/allergyintolerance-recorder",
"type": "reference",
"documentation": "Who recorded the sensitivity"
},
{
"name": "route",
"definition": "http://hl7.org/fhir/SearchParameter/allergyintolerance-route",
"type": "token",
"documentation": "How the subject was exposed to the substance"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/allergyintolerance-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"
}
]
},
{
"type": "Appointment",
"profile": {
"reference": "http://hl7.org/fhir/Appointment"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "partstatus",
"definition": "http://hl7.org/fhir/SearchParameter/appointment-partstatus",
"type": "token",
"documentation": "The Participation status of the subject, or other participant on the appointment"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/appointment-patient",
"type": "reference",
"documentation": "One of the individuals of the appointment is this patient"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/appointment-status",
"type": "token",
"documentation": "The overall status of the appointment"
},
{
"name": "actor",
"definition": "http://hl7.org/fhir/SearchParameter/appointment-actor",
"type": "reference",
"documentation": "Any one of the individuals participating in the appointment"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/appointment-date",
"type": "date",
"documentation": "Appointment date/time."
}
]
},
{
"type": "AppointmentResponse",
"profile": {
"reference": "http://hl7.org/fhir/AppointmentResponse"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "partstatus",
"definition": "http://hl7.org/fhir/SearchParameter/appointmentresponse-partstatus",
"type": "token",
"documentation": "The overall status of the appointment"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/appointmentresponse-subject",
"type": "reference",
"documentation": "The subject that the appointment response replies for"
},
{
"name": "appointment",
"definition": "http://hl7.org/fhir/SearchParameter/appointmentresponse-appointment",
"type": "reference",
"documentation": "The appointment that the response is attached to"
}
]
},
{
"type": "Basic",
"profile": {
"reference": "http://hl7.org/fhir/Basic"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/basic-patient",
"type": "reference",
"documentation": "Identifies the"
},
{
"name": "created",
"definition": "http://hl7.org/fhir/SearchParameter/basic-created",
"type": "date",
"documentation": "When created"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/basic-subject",
"type": "reference",
"documentation": "Identifies the"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/basic-code",
"type": "token",
"documentation": "Kind of Resource"
}
]
},
{
"type": "Binary",
"profile": {
"reference": "http://hl7.org/fhir/Binary"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"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/BodySite"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/bodysite-name",
"type": "token",
"documentation": "Named anatomical location"
}
]
},
{
"type": "Bundle",
"profile": {
"reference": "http://hl7.org/fhir/Bundle"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"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 it's contents"
},
{
"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 it's contents"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/bundle-type",
"type": "token",
"documentation": "document | message | transaction | transaction-response | history | searchset | collection"
}
]
},
{
"type": "CarePlan",
"profile": {
"reference": "http://hl7.org/fhir/CarePlan"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "activitycode",
"definition": "http://hl7.org/fhir/SearchParameter/careplan-activitycode",
"type": "token",
"documentation": "Detail type of activity"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/careplan-patient",
"type": "reference",
"documentation": "Who care plan is for"
},
{
"name": "condition",
"definition": "http://hl7.org/fhir/SearchParameter/careplan-condition",
"type": "reference",
"documentation": "Health issues this plan addresses"
},
{
"name": "activitydetail",
"definition": "http://hl7.org/fhir/SearchParameter/careplan-activitydetail",
"type": "reference",
"documentation": "Activity details defined in specific resource"
},
{
"name": "activitydate",
"definition": "http://hl7.org/fhir/SearchParameter/careplan-activitydate",
"type": "date",
"documentation": "Specified date occurs within period specified by CarePlan.activity.timingSchedule"
},
{
"name": "participant",
"definition": "http://hl7.org/fhir/SearchParameter/careplan-participant",
"type": "reference",
"documentation": "Who is involved"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/careplan-date",
"type": "date",
"documentation": "Time period plan covers"
}
]
},
{
"type": "CarePlan2",
"profile": {
"reference": "http://hl7.org/fhir/CarePlan2"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/careplan2-patient",
"type": "reference",
"documentation": "Who care plan is for"
},
{
"name": "condition",
"definition": "http://hl7.org/fhir/SearchParameter/careplan2-condition",
"type": "reference",
"documentation": "Health issues this plan addresses"
},
{
"name": "participant",
"definition": "http://hl7.org/fhir/SearchParameter/careplan2-participant",
"type": "reference",
"documentation": "Who is involved"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/careplan2-date",
"type": "date",
"documentation": "Time period plan covers"
}
]
},
{
"type": "ClaimResponse",
"profile": {
"reference": "http://hl7.org/fhir/ClaimResponse"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/claimresponse-identifier",
"type": "token",
"documentation": "The identity of the insurer"
}
]
},
{
"type": "ClinicalAssessment",
"profile": {
"reference": "http://hl7.org/fhir/ClinicalAssessment"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "previous",
"definition": "http://hl7.org/fhir/SearchParameter/clinicalassessment-previous",
"type": "reference",
"documentation": "Reference to last assessment"
},
{
"name": "referral",
"definition": "http://hl7.org/fhir/SearchParameter/clinicalassessment-referral",
"type": "reference",
"documentation": "A specific referral that lead to this assessment"
},
{
"name": "diagnosis",
"definition": "http://hl7.org/fhir/SearchParameter/clinicalassessment-diagnosis",
"type": "token",
"documentation": "Specific text or code for diagnosis"
},
{
"name": "problem",
"definition": "http://hl7.org/fhir/SearchParameter/clinicalassessment-problem",
"type": "reference",
"documentation": "General assessment of patient state"
},
{
"name": "careplan",
"definition": "http://hl7.org/fhir/SearchParameter/clinicalassessment-careplan",
"type": "reference",
"documentation": "A specific careplan that prompted this assessment"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/clinicalassessment-date",
"type": "date",
"documentation": "When the assessment occurred"
},
{
"name": "ruledout",
"definition": "http://hl7.org/fhir/SearchParameter/clinicalassessment-ruledout",
"type": "token",
"documentation": "Specific text of code for diagnosis"
},
{
"name": "assessor",
"definition": "http://hl7.org/fhir/SearchParameter/clinicalassessment-assessor",
"type": "reference",
"documentation": "The clinicial performing the assessment"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinicalassessment-patient",
"type": "reference",
"documentation": "The patient being asssesed"
},
{
"name": "resolved",
"definition": "http://hl7.org/fhir/SearchParameter/clinicalassessment-resolved",
"type": "token",
"documentation": "Diagnosies/conditions resolved since previous assessment"
},
{
"name": "plan",
"definition": "http://hl7.org/fhir/SearchParameter/clinicalassessment-plan",
"type": "reference",
"documentation": "Plan of action after assessment"
},
{
"name": "action",
"definition": "http://hl7.org/fhir/SearchParameter/clinicalassessment-action",
"type": "reference",
"documentation": "Actions taken during assessment"
},
{
"name": "investigation",
"definition": "http://hl7.org/fhir/SearchParameter/clinicalassessment-investigation",
"type": "reference",
"documentation": "Record of a specific investigation"
}
]
},
{
"type": "Communication",
"profile": {
"reference": "http://hl7.org/fhir/Communication"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "sender",
"definition": "http://hl7.org/fhir/SearchParameter/communication-sender",
"type": "reference",
"documentation": "Message sender"
},
{
"name": "sent",
"definition": "http://hl7.org/fhir/SearchParameter/communication-sent",
"type": "date",
"documentation": "When sent"
},
{
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/communication-category",
"type": "token",
"documentation": "Message category"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/communication-patient",
"type": "reference",
"documentation": "Focus of message"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/communication-status",
"type": "token",
"documentation": "in-progress | completed | suspended | rejected | failed"
},
{
"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": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/communication-encounter",
"type": "reference",
"documentation": "Encounter leading to message"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/communication-identifier",
"type": "token",
"documentation": "Unique identifier"
},
{
"name": "medium",
"definition": "http://hl7.org/fhir/SearchParameter/communication-medium",
"type": "token",
"documentation": "Communication medium"
},
{
"name": "recipient",
"definition": "http://hl7.org/fhir/SearchParameter/communication-recipient",
"type": "reference",
"documentation": "Message recipient"
}
]
},
{
"type": "CommunicationRequest",
"profile": {
"reference": "http://hl7.org/fhir/CommunicationRequest"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "requester",
"definition": "http://hl7.org/fhir/SearchParameter/communicationrequest-requester",
"type": "reference",
"documentation": "Requester of communication"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/communicationrequest-status",
"type": "token",
"documentation": "proposed | planned | requested | received | accepted | in-progress | completed | suspended | rejected | failed"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/communicationrequest-subject",
"type": "reference",
"documentation": "Focus of message"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/communicationrequest-encounter",
"type": "reference",
"documentation": "Encounter leading to message"
},
{
"name": "recipient",
"definition": "http://hl7.org/fhir/SearchParameter/communicationrequest-recipient",
"type": "reference",
"documentation": "Message recipient"
},
{
"name": "medium",
"definition": "http://hl7.org/fhir/SearchParameter/communicationrequest-medium",
"type": "token",
"documentation": "Communication medium"
},
{
"name": "sender",
"definition": "http://hl7.org/fhir/SearchParameter/communicationrequest-sender",
"type": "reference",
"documentation": "Message sender"
},
{
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/communicationrequest-category",
"type": "token",
"documentation": "Message category"
},
{
"name": "time",
"definition": "http://hl7.org/fhir/SearchParameter/communicationrequest-time",
"type": "date",
"documentation": "When scheduled"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/communicationrequest-patient",
"type": "reference",
"documentation": "Focus of message"
},
{
"name": "ordered",
"definition": "http://hl7.org/fhir/SearchParameter/communicationrequest-ordered",
"type": "date",
"documentation": "When ordered or proposed"
},
{
"name": "priority",
"definition": "http://hl7.org/fhir/SearchParameter/communicationrequest-priority",
"type": "token",
"documentation": "Message urgency"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/communicationrequest-identifier",
"type": "token",
"documentation": "Unique identifier"
}
]
},
{
"type": "Composition",
"profile": {
"reference": "http://hl7.org/fhir/Composition"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "section-code",
"definition": "http://hl7.org/fhir/SearchParameter/composition-section-code",
"type": "token",
"documentation": "Classification of section (recommended)"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/composition-status",
"type": "token",
"documentation": "preliminary | final | appended | amended | entered-in-error"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/composition-subject",
"type": "reference",
"documentation": "Who and/or what the composition is about"
},
{
"name": "class",
"definition": "http://hl7.org/fhir/SearchParameter/composition-class",
"type": "token",
"documentation": "Categorization of Composition"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/composition-type",
"type": "token",
"documentation": "Kind of composition (LOINC if possible)"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/composition-date",
"type": "date",
"documentation": "Composition editing time"
},
{
"name": "period",
"definition": "http://hl7.org/fhir/SearchParameter/composition-period",
"type": "date",
"documentation": "The period covered by the documentation"
},
{
"name": "section",
"definition": "http://hl7.org/fhir/SearchParameter/composition-section",
"type": "reference",
"documentation": "The Content of the section"
},
{
"name": "author",
"definition": "http://hl7.org/fhir/SearchParameter/composition-author",
"type": "reference",
"documentation": "Who and/or what authored the composition"
},
{
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/composition-title",
"type": "string",
"documentation": "Human Readable name/title"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/composition-patient",
"type": "reference",
"documentation": "Who and/or what the composition is about"
},
{
"name": "attester",
"definition": "http://hl7.org/fhir/SearchParameter/composition-attester",
"type": "reference",
"documentation": "Who attested the composition"
},
{
"name": "confidentiality",
"definition": "http://hl7.org/fhir/SearchParameter/composition-confidentiality",
"type": "token",
"documentation": "As defined by affinity domain"
},
{
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/composition-context",
"type": "token",
"documentation": "Code(s) that apply to the event being documented"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/composition-identifier",
"type": "token",
"documentation": "Logical identifier of composition (version-independent)"
}
]
},
{
"type": "ConceptMap",
"profile": {
"reference": "http://hl7.org/fhir/ConceptMap"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "dependson",
"definition": "http://hl7.org/fhir/SearchParameter/conceptmap-dependson",
"type": "token",
"documentation": "Reference to element/field/valueset mapping depends on"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/conceptmap-status",
"type": "token",
"documentation": "Status of the concept map"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/conceptmap-date",
"type": "date",
"documentation": "The concept map publication date"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/conceptmap-url",
"type": "token",
"documentation": "The url of the concept map"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/conceptmap-version",
"type": "token",
"documentation": "The version identifier 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": "product",
"definition": "http://hl7.org/fhir/SearchParameter/conceptmap-product",
"type": "token",
"documentation": "Reference to element/field/valueset mapping depends on"
},
{
"name": "system",
"definition": "http://hl7.org/fhir/SearchParameter/conceptmap-system",
"type": "token",
"documentation": "The system for any destination concepts mapped by this map"
},
{
"name": "source",
"definition": "http://hl7.org/fhir/SearchParameter/conceptmap-source",
"type": "reference",
"documentation": "The system for any concepts mapped by this concept map"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/conceptmap-description",
"type": "string",
"documentation": "Text search in the description of the concept map"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/conceptmap-name",
"type": "string",
"documentation": "Name of the concept map"
},
{
"name": "target",
"definition": "http://hl7.org/fhir/SearchParameter/conceptmap-target",
"type": "reference",
"documentation": "Provides context to the mappings"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/conceptmap-identifier",
"type": "token",
"documentation": "Additional identifier for the concept map"
}
]
},
{
"type": "Condition",
"profile": {
"reference": "http://hl7.org/fhir/Condition"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "asserter",
"definition": "http://hl7.org/fhir/SearchParameter/condition-asserter",
"type": "reference",
"documentation": "Person who asserts this condition"
},
{
"name": "following-code",
"definition": "http://hl7.org/fhir/SearchParameter/condition-following-code",
"type": "token",
"documentation": "Relationship target by means of a predefined code"
},
{
"name": "dueto-code",
"definition": "http://hl7.org/fhir/SearchParameter/condition-dueto-code",
"type": "token",
"documentation": "Relationship target by means of a predefined code"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/condition-status",
"type": "token",
"documentation": "The status of the condition"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/condition-location",
"type": "token",
"documentation": "Location - may include laterality"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/condition-subject",
"type": "reference",
"documentation": "Who has the condition?"
},
{
"name": "onset",
"definition": "http://hl7.org/fhir/SearchParameter/condition-onset",
"type": "date",
"documentation": "When the Condition started (if started on a date)"
},
{
"name": "evidence",
"definition": "http://hl7.org/fhir/SearchParameter/condition-evidence",
"type": "token",
"documentation": "Manifestation/symptom"
},
{
"name": "following-item",
"definition": "http://hl7.org/fhir/SearchParameter/condition-following-item",
"type": "reference",
"documentation": "Relationship target resource"
},
{
"name": "severity",
"definition": "http://hl7.org/fhir/SearchParameter/condition-severity",
"type": "token",
"documentation": "The severity of the condition"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/condition-code",
"type": "token",
"documentation": "Code for the condition"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/condition-encounter",
"type": "reference",
"documentation": "Encounter when condition first asserted"
},
{
"name": "date-asserted",
"definition": "http://hl7.org/fhir/SearchParameter/condition-date-asserted",
"type": "date",
"documentation": "When first detected/suspected/entered"
},
{
"name": "stage",
"definition": "http://hl7.org/fhir/SearchParameter/condition-stage",
"type": "token",
"documentation": "Simple summary (disease specific)"
},
{
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/condition-category",
"type": "token",
"documentation": "The category of the condition"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/condition-patient",
"type": "reference",
"documentation": "Who has the condition?"
},
{
"name": "dueto-item",
"definition": "http://hl7.org/fhir/SearchParameter/condition-dueto-item",
"type": "reference",
"documentation": "Relationship target resource"
}
]
},
{
"type": "Conformance",
"profile": {
"reference": "http://hl7.org/fhir/Conformance"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-status",
"type": "token",
"documentation": "The current status of the conformance statement"
},
{
"name": "resource",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-resource",
"type": "token",
"documentation": "Name of a resource mentioned in a conformance statement"
},
{
"name": "security",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-security",
"type": "token",
"documentation": "Information about security of implementation"
},
{
"name": "format",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-format",
"type": "token",
"documentation": "formats supported (xml | json | mime type)"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-date",
"type": "date",
"documentation": "The conformance statement publication date"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-url",
"type": "token",
"documentation": "The uri that identifies the conformance statement"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-version",
"type": "token",
"documentation": "The version identifier of the conformance statement"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-publisher",
"type": "string",
"documentation": "Name of the publisher of the conformance statement"
},
{
"name": "mode",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-mode",
"type": "token",
"documentation": "Mode - restful (server/client) or messaging (sender/receiver)"
},
{
"name": "software",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-software",
"type": "string",
"documentation": "Part of a the name of a software application"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-description",
"type": "string",
"documentation": "Text search in the description of the conformance statement"
},
{
"name": "event",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-event",
"type": "token",
"documentation": "Event code in a conformance statement"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-name",
"type": "string",
"documentation": "Name of the conformance statement"
},
{
"name": "supported-profile",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-supported-profile",
"type": "reference",
"documentation": "Profiles supported by the system"
},
{
"name": "fhirversion",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-fhirversion",
"type": "token",
"documentation": "The version of FHIR"
},
{
"name": "profile",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-profile",
"type": "reference",
"documentation": "A profile id invoked in a conformance statement"
}
]
},
{
"type": "Contract",
"profile": {
"reference": "http://hl7.org/fhir/Contract"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/contract-patient",
"type": "reference",
"documentation": "The identity of the target of the contract (if a patient)"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/contract-subject",
"type": "reference",
"documentation": "The identity of the target of the contract"
}
]
},
{
"type": "Contraindication",
"profile": {
"reference": "http://hl7.org/fhir/Contraindication"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/contraindication-category",
"type": "token",
"documentation": "E.g. Drug-drug, duplicate therapy, etc."
},
{
"name": "implicated",
"definition": "http://hl7.org/fhir/SearchParameter/contraindication-implicated",
"type": "reference",
"documentation": "Problem resource"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/contraindication-patient",
"type": "reference",
"documentation": "Associated patient"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/contraindication-date",
"type": "date",
"documentation": "When identified"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/contraindication-identifier",
"type": "token",
"documentation": "Unique id for the contraindication"
}
]
},
{
"type": "Coverage",
"profile": {
"reference": "http://hl7.org/fhir/Coverage"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "plan",
"definition": "http://hl7.org/fhir/SearchParameter/coverage-plan",
"type": "token",
"documentation": "A plan or policy identifier"
},
{
"name": "issuer",
"definition": "http://hl7.org/fhir/SearchParameter/coverage-issuer",
"type": "reference",
"documentation": "The identity of the insurer"
},
{
"name": "sequence",
"definition": "http://hl7.org/fhir/SearchParameter/coverage-sequence",
"type": "token",
"documentation": "Sequence number"
},
{
"name": "dependent",
"definition": "http://hl7.org/fhir/SearchParameter/coverage-dependent",
"type": "token",
"documentation": "Dependent number"
},
{
"name": "group",
"definition": "http://hl7.org/fhir/SearchParameter/coverage-group",
"type": "token",
"documentation": "Group identifier"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/coverage-type",
"type": "token",
"documentation": "The kind of coverage"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/coverage-identifier",
"type": "token",
"documentation": "The primary identifier of the insured"
},
{
"name": "subplan",
"definition": "http://hl7.org/fhir/SearchParameter/coverage-subplan",
"type": "token",
"documentation": "Sub-plan identifier"
}
]
},
{
"type": "DataElement",
"profile": {
"reference": "http://hl7.org/fhir/DataElement"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/dataelement-category",
"type": "token",
"documentation": "A category assigned to the data element (server may choose to do subsumption)"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/dataelement-status",
"type": "token",
"documentation": "The current status 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"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/dataelement-name",
"type": "string",
"documentation": "Name of 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": "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": "The identifier 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": "version",
"definition": "http://hl7.org/fhir/SearchParameter/dataelement-version",
"type": "string",
"documentation": "The version identifier of the data element"
}
]
},
{
"type": "Device",
"profile": {
"reference": "http://hl7.org/fhir/Device"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"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": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/device-patient",
"type": "reference",
"documentation": "Patient information, if the resource is affixed to a person"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/device-location",
"type": "reference",
"documentation": "A location, where the resource is found"
},
{
"name": "manufacturer",
"definition": "http://hl7.org/fhir/SearchParameter/device-manufacturer",
"type": "string",
"documentation": "The manufacturer of the device"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/device-type",
"type": "token",
"documentation": "The type of the device"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/device-identifier",
"type": "token",
"documentation": "Instance id from manufacturer, owner, regulatory agencies and others"
}
]
},
{
"type": "DeviceComponent",
"profile": {
"reference": "http://hl7.org/fhir/DeviceComponent"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "source",
"definition": "http://hl7.org/fhir/SearchParameter/devicecomponent-source",
"type": "reference",
"documentation": "The device source"
},
{
"name": "parent",
"definition": "http://hl7.org/fhir/SearchParameter/devicecomponent-parent",
"type": "reference",
"documentation": "The parent DeviceComponent resource"
},
{
"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/DeviceMetric"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/devicemetric-category",
"type": "token",
"documentation": "The category of the metric"
},
{
"name": "source",
"definition": "http://hl7.org/fhir/SearchParameter/devicemetric-source",
"type": "reference",
"documentation": "The device resource"
},
{
"name": "parent",
"definition": "http://hl7.org/fhir/SearchParameter/devicemetric-parent",
"type": "reference",
"documentation": "The parent DeviceMetric resource"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/devicemetric-type",
"type": "token",
"documentation": "The component type"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/devicemetric-identifier",
"type": "token",
"documentation": "The identifier of the metric"
}
]
},
{
"type": "DeviceUseRequest",
"profile": {
"reference": "http://hl7.org/fhir/DeviceUseRequest"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/deviceuserequest-patient",
"type": "reference",
"documentation": "Search by subject - a patient"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/deviceuserequest-subject",
"type": "reference",
"documentation": "Search by subject"
}
]
},
{
"type": "DeviceUseStatement",
"profile": {
"reference": "http://hl7.org/fhir/DeviceUseStatement"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/deviceusestatement-patient",
"type": "reference",
"documentation": "Search by subject - a patient"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/deviceusestatement-subject",
"type": "reference",
"documentation": "Search by subject"
}
]
},
{
"type": "DiagnosticOrder",
"profile": {
"reference": "http://hl7.org/fhir/DiagnosticOrder"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "orderer",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticorder-orderer",
"type": "reference",
"documentation": "Who ordered the test"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticorder-status",
"type": "token",
"documentation": "proposed | planned | requested | received | accepted | in-progress | review | completed | suspended | rejected | failed"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticorder-subject",
"type": "reference",
"documentation": "Who and/or what test is about"
},
{
"name": "item-status",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticorder-item-status",
"type": "token",
"documentation": "proposed | planned | requested | received | accepted | in-progress | review | completed | suspended | rejected | failed"
},
{
"name": "event-status",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticorder-event-status",
"type": "token",
"documentation": "proposed | planned | requested | received | accepted | in-progress | review | completed | suspended | rejected | failed"
},
{
"name": "actor",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticorder-actor",
"type": "reference",
"documentation": "Who recorded or did this"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticorder-code",
"type": "token",
"documentation": "Code to indicate the item (test or panel) being ordered"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticorder-encounter",
"type": "reference",
"documentation": "The encounter that this diagnostic order is associated with"
},
{
"name": "item-past-status",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticorder-item-past-status",
"type": "token",
"documentation": "proposed | planned | requested | received | accepted | in-progress | review | completed | suspended | rejected | failed"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticorder-patient",
"type": "reference",
"documentation": "Who and/or what test is about"
},
{
"name": "bodysite",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticorder-bodysite",
"type": "token",
"documentation": "Location of requested test (if applicable)"
},
{
"name": "item-date",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticorder-item-date",
"type": "date",
"documentation": "The date at which the event happened"
},
{
"name": "specimen",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticorder-specimen",
"type": "reference",
"documentation": "If the whole order relates to specific specimens"
},
{
"name": "event-status-date",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticorder-event-status-date",
"type": "composite",
"documentation": "A combination of past-status and date"
},
{
"name": "event-date",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticorder-event-date",
"type": "date",
"documentation": "The date at which the event happened"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticorder-identifier",
"type": "token",
"documentation": "Identifiers assigned to this order"
},
{
"name": "item-status-date",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticorder-item-status-date",
"type": "composite",
"documentation": "A combination of item-past-status and item-date"
}
]
},
{
"type": "DiagnosticReport",
"profile": {
"reference": "http://hl7.org/fhir/DiagnosticReport"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "result",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticreport-result",
"type": "reference",
"documentation": "Link to an atomic result (observation resource)"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticreport-status",
"type": "token",
"documentation": "The status of the report"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticreport-subject",
"type": "reference",
"documentation": "The subject of the report"
},
{
"name": "issued",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticreport-issued",
"type": "date",
"documentation": "When the report was issued"
},
{
"name": "diagnosis",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticreport-diagnosis",
"type": "token",
"documentation": "A coded diagnosis on the report"
},
{
"name": "image",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticreport-image",
"type": "reference",
"documentation": "Reference to the image source"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticreport-encounter",
"type": "reference",
"documentation": "The Encounter when the order was made"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticreport-date",
"type": "date",
"documentation": "The clinically relevant time of the report"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticreport-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": "name",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticreport-name",
"type": "token",
"documentation": "The name of the report (e.g. 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": "request",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticreport-request",
"type": "reference",
"documentation": "What was requested"
},
{
"name": "service",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticreport-service",
"type": "token",
"documentation": "Which diagnostic discipline/department created the report"
},
{
"name": "performer",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticreport-performer",
"type": "reference",
"documentation": "Who was the source of the report (organization)"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticreport-identifier",
"type": "token",
"documentation": "An identifier for the report"
}
]
},
{
"type": "DocumentManifest",
"profile": {
"reference": "http://hl7.org/fhir/DocumentManifest"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "supersedes",
"definition": "http://hl7.org/fhir/SearchParameter/documentmanifest-supersedes",
"type": "reference",
"documentation": "If this document manifest replaces another"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/documentmanifest-status",
"type": "token",
"documentation": "current | superceded | entered-in-error"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/documentmanifest-subject",
"type": "reference",
"documentation": "The subject of the set of documents"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/documentmanifest-type",
"type": "token",
"documentation": "What kind of document set this is"
},
{
"name": "recipient",
"definition": "http://hl7.org/fhir/SearchParameter/documentmanifest-recipient",
"type": "reference",
"documentation": "Intended to get notified about this set of documents"
},
{
"name": "content",
"definition": "http://hl7.org/fhir/SearchParameter/documentmanifest-content",
"type": "reference",
"documentation": "Contents of this set of documents"
},
{
"name": "author",
"definition": "http://hl7.org/fhir/SearchParameter/documentmanifest-author",
"type": "reference",
"documentation": "Who and/or what authored the document"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/documentmanifest-patient",
"type": "reference",
"documentation": "The subject of the set of documents"
},
{
"name": "source",
"definition": "http://hl7.org/fhir/SearchParameter/documentmanifest-source",
"type": "string",
"documentation": "The source system/application/software"
},
{
"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": "confidentiality",
"definition": "http://hl7.org/fhir/SearchParameter/documentmanifest-confidentiality",
"type": "token",
"documentation": "Sensitivity of set of documents"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/documentmanifest-identifier",
"type": "token",
"documentation": "Unique Identifier for the set of documents"
}
]
},
{
"type": "DocumentReference",
"profile": {
"reference": "http://hl7.org/fhir/DocumentReference"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-location",
"type": "string",
"documentation": "Uri where the data can be found"
},
{
"name": "indexed",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-indexed",
"type": "date",
"documentation": "When this document reference created"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-status",
"type": "token",
"documentation": "current | superceded | entered-in-error"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-subject",
"type": "reference",
"documentation": "Who|what is the subject of the document"
},
{
"name": "relatesto",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-relatesto",
"type": "reference",
"documentation": "Target of the relationship"
},
{
"name": "relation",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-relation",
"type": "token",
"documentation": "replaces | transforms | signs | appends"
},
{
"name": "class",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-class",
"type": "token",
"documentation": "High-level classification of document"
},
{
"name": "format",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-format",
"type": "token",
"documentation": "Format/content rules for the document"
},
{
"name": "period",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-period",
"type": "date",
"documentation": "Time of service that is being documented"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-type",
"type": "token",
"documentation": "Precice type of document"
},
{
"name": "authenticator",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-authenticator",
"type": "reference",
"documentation": "Who/What authenticated the document"
},
{
"name": "relationship",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-relationship",
"type": "composite",
"documentation": "Combination of relation and relatesTo"
},
{
"name": "author",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-author",
"type": "reference",
"documentation": "Who and/or what authored the document"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-patient",
"type": "reference",
"documentation": "Who|what is the subject of the document"
},
{
"name": "custodian",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-custodian",
"type": "reference",
"documentation": "Org which maintains the document"
},
{
"name": "facility",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-facility",
"type": "token",
"documentation": "Kind of facility where patient was seen"
},
{
"name": "created",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-created",
"type": "date",
"documentation": "Document creation time"
},
{
"name": "event",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-event",
"type": "token",
"documentation": "Main Clinical Acts Documented"
},
{
"name": "confidentiality",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-confidentiality",
"type": "token",
"documentation": "Sensitivity of source 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": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-identifier",
"type": "token",
"documentation": "Master Version Specific Identifier"
}
]
},
{
"type": "EligibilityRequest",
"profile": {
"reference": "http://hl7.org/fhir/EligibilityRequest"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/eligibilityrequest-identifier",
"type": "token",
"documentation": "The business identifier of the Eligibility"
}
]
},
{
"type": "EligibilityResponse",
"profile": {
"reference": "http://hl7.org/fhir/EligibilityResponse"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/eligibilityresponse-identifier",
"type": "token",
"documentation": "The business identifier of the Explanation of Benefit"
}
]
},
{
"type": "Encounter",
"profile": {
"reference": "http://hl7.org/fhir/Encounter"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "participant-type",
"definition": "http://hl7.org/fhir/SearchParameter/encounter-participant-type",
"type": "token",
"documentation": "Role of participant in encounter"
},
{
"name": "episodeofcare",
"definition": "http://hl7.org/fhir/SearchParameter/encounter-episodeofcare",
"type": "reference",
"documentation": "An episode of care that this encounter should be recorded against"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/encounter-status",
"type": "token",
"documentation": "planned | arrived | in-progress | onleave | finished | cancelled"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/encounter-location",
"type": "reference",
"documentation": "Location the encounter takes place"
},
{
"name": "indication",
"definition": "http://hl7.org/fhir/SearchParameter/encounter-indication",
"type": "reference",
"documentation": "Reason the encounter takes place (resource)"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/encounter-date",
"type": "date",
"documentation": "A date within the period the Encounter lasted"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/encounter-type",
"type": "token",
"documentation": "Specific type of encounter"
},
{
"name": "special-arrangement",
"definition": "http://hl7.org/fhir/SearchParameter/encounter-special-arrangement",
"type": "token",
"documentation": "Wheelchair, translator, stretcher, etc"
},
{
"name": "part-of",
"definition": "http://hl7.org/fhir/SearchParameter/encounter-part-of",
"type": "reference",
"documentation": "Another Encounter this encounter is part of"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/encounter-patient",
"type": "reference",
"documentation": "The patient present at the encounter"
},
{
"name": "length",
"definition": "http://hl7.org/fhir/SearchParameter/encounter-length",
"type": "number",
"documentation": "Length of encounter in days"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/encounter-identifier",
"type": "token",
"documentation": "Identifier(s) by which this encounter is known"
},
{
"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"
}
]
},
{
"type": "EnrollmentRequest",
"profile": {
"reference": "http://hl7.org/fhir/EnrollmentRequest"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/enrollmentrequest-patient",
"type": "reference",
"documentation": "The party to be enrolled"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/enrollmentrequest-subject",
"type": "reference",
"documentation": "The party to be enrolled"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/enrollmentrequest-identifier",
"type": "token",
"documentation": "The business identifier of the Enrollment"
}
]
},
{
"type": "EnrollmentResponse",
"profile": {
"reference": "http://hl7.org/fhir/EnrollmentResponse"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/enrollmentresponse-identifier",
"type": "token",
"documentation": "The business identifier of the Explanation of Benefit"
}
]
},
{
"type": "EpisodeOfCare",
"profile": {
"reference": "http://hl7.org/fhir/EpisodeOfCare"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/episodeofcare-organization",
"type": "reference",
"documentation": "The organization that has assumed the specific responsibilities for the specified duration"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/episodeofcare-patient",
"type": "reference",
"documentation": "The patient that this episodeofcare applies to"
},
{
"name": "condition",
"definition": "http://hl7.org/fhir/SearchParameter/episodeofcare-condition",
"type": "reference",
"documentation": "A list of conditions/problems/diagnoses that this episode of care is intended to be providing care for"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/episodeofcare-status",
"type": "token",
"documentation": "planned | active | onhold | finished | withdrawn | other"
},
{
"name": "referral",
"definition": "http://hl7.org/fhir/SearchParameter/episodeofcare-referral",
"type": "reference",
"documentation": "A Referral Request that this EpisodeOfCare manages activities within"
},
{
"name": "care-manager",
"definition": "http://hl7.org/fhir/SearchParameter/episodeofcare-care-manager",
"type": "reference",
"documentation": "The practitioner that is the care manager/care co-ordinator for this patient"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/episodeofcare-type",
"type": "token",
"documentation": "Specific type of EpisodeOfcare"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/episodeofcare-date",
"type": "date",
"documentation": "The interval during which the managing organization assumes the defined responsibility"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/episodeofcare-identifier",
"type": "token",
"documentation": "Identifier(s) by which this EpisodeOfCare is known"
}
]
},
{
"type": "ExplanationOfBenefit",
"profile": {
"reference": "http://hl7.org/fhir/ExplanationOfBenefit"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/explanationofbenefit-identifier",
"type": "token",
"documentation": "The business identifier of the Explanation of Benefit"
}
]
},
{
"type": "ExtensionDefinition",
"profile": {
"reference": "http://hl7.org/fhir/ExtensionDefinition"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "valueset",
"definition": "http://hl7.org/fhir/SearchParameter/extensiondefinition-valueset",
"type": "reference",
"documentation": "Source of value set"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/extensiondefinition-status",
"type": "token",
"documentation": "draft | active | retired"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/extensiondefinition-description",
"type": "string",
"documentation": "Natural language description of the extension"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/extensiondefinition-name",
"type": "string",
"documentation": "Descriptional name for this profile"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/extensiondefinition-code",
"type": "token",
"documentation": "Assist with indexing and finding"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/extensiondefinition-date",
"type": "date",
"documentation": "Date for this version of the extension"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/extensiondefinition-identifier",
"type": "token",
"documentation": "Other identifiers for the extension"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/extensiondefinition-url",
"type": "token",
"documentation": "Literal URL used to reference this extension"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/extensiondefinition-publisher",
"type": "string",
"documentation": "Name of the publisher (Organization or individual)"
}
]
},
{
"type": "FamilyHistory",
"profile": {
"reference": "http://hl7.org/fhir/FamilyHistory"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/familyhistory-patient",
"type": "reference",
"documentation": "The identity of a subject to list family history items for"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/familyhistory-date",
"type": "date",
"documentation": "When history was captured/updated"
}
]
},
{
"type": "Goal",
"profile": {
"reference": "http://hl7.org/fhir/Goal"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/goal-patient",
"type": "reference",
"documentation": "The patient for whom this goal is intended for"
}
]
},
{
"type": "Group",
"profile": {
"reference": "http://hl7.org/fhir/Group"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "member",
"definition": "http://hl7.org/fhir/SearchParameter/group-member",
"type": "reference",
"documentation": "Who is in group"
},
{
"name": "characteristic-value",
"definition": "http://hl7.org/fhir/SearchParameter/group-characteristic-value",
"type": "composite",
"documentation": "A composite of both characteristic and value"
},
{
"name": "value",
"definition": "http://hl7.org/fhir/SearchParameter/group-value",
"type": "token",
"documentation": "Value held by characteristic"
},
{
"name": "actual",
"definition": "http://hl7.org/fhir/SearchParameter/group-actual",
"type": "token",
"documentation": "Descriptive or actual"
},
{
"name": "exclude",
"definition": "http://hl7.org/fhir/SearchParameter/group-exclude",
"type": "token",
"documentation": "Group includes or excludes"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/group-code",
"type": "token",
"documentation": "The kind of resources contained"
},
{
"name": "characteristic",
"definition": "http://hl7.org/fhir/SearchParameter/group-characteristic",
"type": "token",
"documentation": "Kind of characteristic"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/group-type",
"type": "token",
"documentation": "The type of resources the group contains"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/group-identifier",
"type": "token",
"documentation": "Unique id"
}
]
},
{
"type": "HealthcareService",
"profile": {
"reference": "http://hl7.org/fhir/HealthcareService"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "servicecategory",
"definition": "http://hl7.org/fhir/SearchParameter/healthcareservice-servicecategory",
"type": "token",
"documentation": "Service Category of the Healthcare Service"
},
{
"name": "servicetype",
"definition": "http://hl7.org/fhir/SearchParameter/healthcareservice-servicetype",
"type": "token",
"documentation": "The type of service provided by this healthcare service"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/healthcareservice-location",
"type": "reference",
"documentation": "The location of the Healthcare Service"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/healthcareservice-name",
"type": "string",
"documentation": "A portion of the Healthcare service name"
}
]
},
{
"type": "ImagingObjectSelection",
"profile": {
"reference": "http://hl7.org/fhir/ImagingObjectSelection"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "selected-study",
"definition": "http://hl7.org/fhir/SearchParameter/imagingobjectselection-selected-study",
"type": "token",
"documentation": "Study selected in key DICOM object selection"
},
{
"name": "author",
"definition": "http://hl7.org/fhir/SearchParameter/imagingobjectselection-author",
"type": "reference",
"documentation": "Author of key DICOM object selection"
},
{
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/imagingobjectselection-title",
"type": "token",
"documentation": "Title of key DICOM object selection"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/imagingobjectselection-patient",
"type": "reference",
"documentation": "Subject of key DICOM object selection"
},
{
"name": "authoring-time",
"definition": "http://hl7.org/fhir/SearchParameter/imagingobjectselection-authoring-time",
"type": "date",
"documentation": "Time of key DICOM object selection authoring"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/imagingobjectselection-identifier",
"type": "token",
"documentation": "UID of key DICOM object selection"
}
]
},
{
"type": "ImagingStudy",
"profile": {
"reference": "http://hl7.org/fhir/ImagingStudy"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "uid",
"definition": "http://hl7.org/fhir/SearchParameter/imagingstudy-uid",
"type": "token",
"documentation": "Formal identifier for this instance (0008,0018)"
},
{
"name": "series",
"definition": "http://hl7.org/fhir/SearchParameter/imagingstudy-series",
"type": "token",
"documentation": "The series id for the image"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/imagingstudy-patient",
"type": "reference",
"documentation": "Who the study is about"
},
{
"name": "bodysite",
"definition": "http://hl7.org/fhir/SearchParameter/imagingstudy-bodysite",
"type": "token",
"documentation": "Body part examined (Map from 0018,0015)"
},
{
"name": "accession",
"definition": "http://hl7.org/fhir/SearchParameter/imagingstudy-accession",
"type": "token",
"documentation": "The accession id for the image"
},
{
"name": "study",
"definition": "http://hl7.org/fhir/SearchParameter/imagingstudy-study",
"type": "token",
"documentation": "The study id for the image"
},
{
"name": "modality",
"definition": "http://hl7.org/fhir/SearchParameter/imagingstudy-modality",
"type": "token",
"documentation": "The modality of the image"
},
{
"name": "started",
"definition": "http://hl7.org/fhir/SearchParameter/imagingstudy-started",
"type": "date",
"documentation": "When the study was started"
},
{
"name": "dicom-class",
"definition": "http://hl7.org/fhir/SearchParameter/imagingstudy-dicom-class",
"type": "token",
"documentation": "DICOM class type (0008,0016)"
},
{
"name": "size",
"definition": "http://hl7.org/fhir/SearchParameter/imagingstudy-size",
"type": "number",
"documentation": "The size of the image in MB - may include > or < in the value"
}
]
},
{
"type": "Immunization",
"profile": {
"reference": "http://hl7.org/fhir/Immunization"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "reaction",
"definition": "http://hl7.org/fhir/SearchParameter/immunization-reaction",
"type": "reference",
"documentation": "Additional information on reaction"
},
{
"name": "dose-sequence",
"definition": "http://hl7.org/fhir/SearchParameter/immunization-dose-sequence",
"type": "number",
"documentation": "What dose number within series?"
},
{
"name": "requester",
"definition": "http://hl7.org/fhir/SearchParameter/immunization-requester",
"type": "reference",
"documentation": "The practitioner who ordered the vaccination"
},
{
"name": "vaccine-type",
"definition": "http://hl7.org/fhir/SearchParameter/immunization-vaccine-type",
"type": "token",
"documentation": "Vaccine Product Type 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": "reason",
"definition": "http://hl7.org/fhir/SearchParameter/immunization-reason",
"type": "token",
"documentation": "Why immunization occurred"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/immunization-subject",
"type": "reference",
"documentation": "The patient for the vaccination record"
},
{
"name": "reaction-date",
"definition": "http://hl7.org/fhir/SearchParameter/immunization-reaction-date",
"type": "date",
"documentation": "When did reaction start?"
},
{
"name": "notgiven",
"definition": "http://hl7.org/fhir/SearchParameter/immunization-notgiven",
"type": "token",
"documentation": "Administrations which were not given"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/immunization-date",
"type": "date",
"documentation": "Vaccination (non)-Administration Date"
},
{
"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": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/immunization-patient",
"type": "reference",
"documentation": "The patient for the vaccination record"
},
{
"name": "lot-number",
"definition": "http://hl7.org/fhir/SearchParameter/immunization-lot-number",
"type": "string",
"documentation": "Vaccine Lot Number"
},
{
"name": "manufacturer",
"definition": "http://hl7.org/fhir/SearchParameter/immunization-manufacturer",
"type": "reference",
"documentation": "Vaccine Manufacturer"
},
{
"name": "performer",
"definition": "http://hl7.org/fhir/SearchParameter/immunization-performer",
"type": "reference",
"documentation": "The practitioner who administered the vaccination"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/immunization-identifier",
"type": "token",
"documentation": "Business identifier"
}
]
},
{
"type": "ImmunizationRecommendation",
"profile": {
"reference": "http://hl7.org/fhir/ImmunizationRecommendation"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "information",
"definition": "http://hl7.org/fhir/SearchParameter/immunizationrecommendation-information",
"type": "reference",
"documentation": "Patient observations supporting recommendation"
},
{
"name": "dose-sequence",
"definition": "http://hl7.org/fhir/SearchParameter/immunizationrecommendation-dose-sequence",
"type": "token",
"documentation": "Number of dose within sequence"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/immunizationrecommendation-patient",
"type": "reference",
"documentation": "Who this profile is for"
},
{
"name": "support",
"definition": "http://hl7.org/fhir/SearchParameter/immunizationrecommendation-support",
"type": "reference",
"documentation": "Past immunizations supporting recommendation"
},
{
"name": "vaccine-type",
"definition": "http://hl7.org/fhir/SearchParameter/immunizationrecommendation-vaccine-type",
"type": "token",
"documentation": "Vaccine recommendation applies to"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/immunizationrecommendation-status",
"type": "token",
"documentation": "Vaccine administration status"
},
{
"name": "dose-number",
"definition": "http://hl7.org/fhir/SearchParameter/immunizationrecommendation-dose-number",
"type": "number",
"documentation": "Recommended dose number"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/immunizationrecommendation-subject",
"type": "reference",
"documentation": "Who this profile is for"
},
{
"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"
}
]
},
{
"type": "InstitutionalClaim",
"profile": {
"reference": "http://hl7.org/fhir/InstitutionalClaim"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/institutionalclaim-patient",
"type": "reference",
"documentation": "Patient"
},
{
"name": "priority",
"definition": "http://hl7.org/fhir/SearchParameter/institutionalclaim-priority",
"type": "token",
"documentation": "Processing priority requested"
},
{
"name": "use",
"definition": "http://hl7.org/fhir/SearchParameter/institutionalclaim-use",
"type": "token",
"documentation": "The kind of financial resource"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/institutionalclaim-identifier",
"type": "token",
"documentation": "The primary identifier of the financial resource"
}
]
},
{
"type": "List",
"profile": {
"reference": "http://hl7.org/fhir/List"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/list-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"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/list-subject",
"type": "reference",
"documentation": "If all resources have the same subject"
},
{
"name": "item",
"definition": "http://hl7.org/fhir/SearchParameter/list-item",
"type": "reference",
"documentation": "Actual entry"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/list-code",
"type": "token",
"documentation": "What the purpose of this list is"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/list-date",
"type": "date",
"documentation": "When the list was prepared"
},
{
"name": "empty-reason",
"definition": "http://hl7.org/fhir/SearchParameter/list-empty-reason",
"type": "token",
"documentation": "Why list is empty"
}
]
},
{
"type": "Location",
"profile": {
"reference": "http://hl7.org/fhir/Location"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/location-organization",
"type": "reference",
"documentation": "Searches for locations that are managed by the provided organization"
},
{
"name": "near",
"definition": "http://hl7.org/fhir/SearchParameter/location-near",
"type": "token",
"documentation": "The coordinates expressed as [lat],[long] (using KML, see notes) to find locations near to (servers may search using a square rather than a circle for efficiency)"
},
{
"name": "partof",
"definition": "http://hl7.org/fhir/SearchParameter/location-partof",
"type": "reference",
"documentation": "The location of which this location is a part"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/location-status",
"type": "token",
"documentation": "Searches for locations with a specific kind of status"
},
{
"name": "address",
"definition": "http://hl7.org/fhir/SearchParameter/location-address",
"type": "string",
"documentation": "A (part of the) address of the location"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/location-name",
"type": "string",
"documentation": "A (portion of the) name of the location"
},
{
"name": "near-distance",
"definition": "http://hl7.org/fhir/SearchParameter/location-near-distance",
"type": "token",
"documentation": "A distance quantity to limit the near search to locations within a specific distance"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/location-type",
"type": "token",
"documentation": "A code for the type of location"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/location-identifier",
"type": "token",
"documentation": "Unique code or number identifying the location to its users"
}
]
},
{
"type": "Media",
"profile": {
"reference": "http://hl7.org/fhir/Media"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/media-patient",
"type": "reference",
"documentation": "Who/What this Media is a record of"
},
{
"name": "created",
"definition": "http://hl7.org/fhir/SearchParameter/media-created",
"type": "date",
"documentation": "When the media was taken/recorded (start)"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/media-subject",
"type": "reference",
"documentation": "Who/What this Media is a record of"
},
{
"name": "subtype",
"definition": "http://hl7.org/fhir/SearchParameter/media-subtype",
"type": "token",
"documentation": "The type of acquisition equipment/process"
},
{
"name": "view",
"definition": "http://hl7.org/fhir/SearchParameter/media-view",
"type": "token",
"documentation": "Imaging view e.g Lateral or Antero-posterior"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/media-type",
"type": "token",
"documentation": "photo | video | audio"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/media-identifier",
"type": "token",
"documentation": "Identifier(s) for the image"
},
{
"name": "operator",
"definition": "http://hl7.org/fhir/SearchParameter/media-operator",
"type": "reference",
"documentation": "The person who generated the image"
}
]
},
{
"type": "Medication",
"profile": {
"reference": "http://hl7.org/fhir/Medication"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "content",
"definition": "http://hl7.org/fhir/SearchParameter/medication-content",
"type": "reference",
"documentation": "A product in the package"
},
{
"name": "form",
"definition": "http://hl7.org/fhir/SearchParameter/medication-form",
"type": "token",
"documentation": "powder | tablets | carton +"
},
{
"name": "container",
"definition": "http://hl7.org/fhir/SearchParameter/medication-container",
"type": "token",
"documentation": "E.g. box, vial, blister-pack"
},
{
"name": "manufacturer",
"definition": "http://hl7.org/fhir/SearchParameter/medication-manufacturer",
"type": "reference",
"documentation": "Manufacturer of the item"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/medication-name",
"type": "string",
"documentation": "Common / Commercial name"
},
{
"name": "ingredient",
"definition": "http://hl7.org/fhir/SearchParameter/medication-ingredient",
"type": "reference",
"documentation": "The product contained"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/medication-code",
"type": "token",
"documentation": "Codes that identify this medication"
}
]
},
{
"type": "MedicationAdministration",
"profile": {
"reference": "http://hl7.org/fhir/MedicationAdministration"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "medication",
"definition": "http://hl7.org/fhir/SearchParameter/medicationadministration-medication",
"type": "reference",
"documentation": "Return administrations of this medication"
},
{
"name": "effectivetime",
"definition": "http://hl7.org/fhir/SearchParameter/medicationadministration-effectivetime",
"type": "date",
"documentation": "Date administration happened (or did not happen)"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/medicationadministration-patient",
"type": "reference",
"documentation": "The identity of a patient to list administrations for"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/medicationadministration-status",
"type": "token",
"documentation": "MedicationAdministration event status (for example one of active/paused/completed/nullified)"
},
{
"name": "prescription",
"definition": "http://hl7.org/fhir/SearchParameter/medicationadministration-prescription",
"type": "reference",
"documentation": "The identity of a prescription to list administrations from"
},
{
"name": "device",
"definition": "http://hl7.org/fhir/SearchParameter/medicationadministration-device",
"type": "reference",
"documentation": "Return administrations with this administration device identity"
},
{
"name": "notgiven",
"definition": "http://hl7.org/fhir/SearchParameter/medicationadministration-notgiven",
"type": "token",
"documentation": "Administrations that were not made"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/medicationadministration-encounter",
"type": "reference",
"documentation": "Return administrations that share this encounter"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/medicationadministration-identifier",
"type": "token",
"documentation": "Return administrations with this external identity"
}
]
},
{
"type": "MedicationDispense",
"profile": {
"reference": "http://hl7.org/fhir/MedicationDispense"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "medication",
"definition": "http://hl7.org/fhir/SearchParameter/medicationdispense-medication",
"type": "reference",
"documentation": "Returns dispenses of this medicine"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/medicationdispense-patient",
"type": "reference",
"documentation": "The identity of a patient to list dispenses for"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/medicationdispense-status",
"type": "token",
"documentation": "Status of the dispense"
},
{
"name": "prescription",
"definition": "http://hl7.org/fhir/SearchParameter/medicationdispense-prescription",
"type": "reference",
"documentation": "The identity of a prescription to list dispenses from"
},
{
"name": "responsibleparty",
"definition": "http://hl7.org/fhir/SearchParameter/medicationdispense-responsibleparty",
"type": "reference",
"documentation": "Return all dispenses with the specified responsible party"
},
{
"name": "dispenser",
"definition": "http://hl7.org/fhir/SearchParameter/medicationdispense-dispenser",
"type": "reference",
"documentation": "Return all dispenses performed by a specific indiividual"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/medicationdispense-type",
"type": "token",
"documentation": "Return all dispenses of a specific type"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/medicationdispense-identifier",
"type": "token",
"documentation": "Return dispenses with this external identity"
},
{
"name": "whenprepared",
"definition": "http://hl7.org/fhir/SearchParameter/medicationdispense-whenprepared",
"type": "date",
"documentation": "Date when medication prepared"
},
{
"name": "whenhandedover",
"definition": "http://hl7.org/fhir/SearchParameter/medicationdispense-whenhandedover",
"type": "date",
"documentation": "Date when medication handed over to patient (outpatient setting), or supplied to ward or clinic (inpatient setting)"
},
{
"name": "destination",
"definition": "http://hl7.org/fhir/SearchParameter/medicationdispense-destination",
"type": "reference",
"documentation": "Return dispenses that should be sent to a secific destination"
}
]
},
{
"type": "MedicationPrescription",
"profile": {
"reference": "http://hl7.org/fhir/MedicationPrescription"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "medication",
"definition": "http://hl7.org/fhir/SearchParameter/medicationprescription-medication",
"type": "reference",
"documentation": "Code for medicine or text in medicine name"
},
{
"name": "datewritten",
"definition": "http://hl7.org/fhir/SearchParameter/medicationprescription-datewritten",
"type": "date",
"documentation": "Return prescriptions written on this date"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/medicationprescription-patient",
"type": "reference",
"documentation": "The identity of a patient to list dispenses for"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/medicationprescription-status",
"type": "token",
"documentation": "Status of the prescription"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/medicationprescription-encounter",
"type": "reference",
"documentation": "Return prescriptions with this encounter identity"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/medicationprescription-identifier",
"type": "token",
"documentation": "Return prescriptions with this external identity"
}
]
},
{
"type": "MedicationStatement",
"profile": {
"reference": "http://hl7.org/fhir/MedicationStatement"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "medication",
"definition": "http://hl7.org/fhir/SearchParameter/medicationstatement-medication",
"type": "reference",
"documentation": "Code for medicine or text in medicine name"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/medicationstatement-patient",
"type": "reference",
"documentation": "The identity of a patient to list administrations for"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/medicationstatement-status",
"type": "string",
"documentation": "Return statements that match the given status"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/medicationstatement-identifier",
"type": "token",
"documentation": "Return administrations with this external identity"
},
{
"name": "effectivedate",
"definition": "http://hl7.org/fhir/SearchParameter/medicationstatement-effectivedate",
"type": "date",
"documentation": "Date when patient was taking (or not taking) the medication"
}
]
},
{
"type": "MessageHeader",
"profile": {
"reference": "http://hl7.org/fhir/MessageHeader"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "destination-uri",
"definition": "http://hl7.org/fhir/SearchParameter/messageheader-destination-uri",
"type": "token",
"documentation": "Actual destination address or id"
},
{
"name": "timestamp",
"definition": "http://hl7.org/fhir/SearchParameter/messageheader-timestamp",
"type": "date",
"documentation": "Time that the message was sent"
},
{
"name": "source-uri",
"definition": "http://hl7.org/fhir/SearchParameter/messageheader-source-uri",
"type": "token",
"documentation": "Actual message source address or id"
},
{
"name": "receiver",
"definition": "http://hl7.org/fhir/SearchParameter/messageheader-receiver",
"type": "reference",
"documentation": "Intended \"real-world\" recipient for the data"
},
{
"name": "source",
"definition": "http://hl7.org/fhir/SearchParameter/messageheader-source",
"type": "string",
"documentation": "Name of system"
},
{
"name": "event",
"definition": "http://hl7.org/fhir/SearchParameter/messageheader-event",
"type": "token",
"documentation": "Code for the event this message represents"
},
{
"name": "data",
"definition": "http://hl7.org/fhir/SearchParameter/messageheader-data",
"type": "reference",
"documentation": "The actual content of the message"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/messageheader-code",
"type": "token",
"documentation": "ok | transient-error | fatal-error"
},
{
"name": "response-id",
"definition": "http://hl7.org/fhir/SearchParameter/messageheader-response-id",
"type": "token",
"documentation": "Id of original message"
},
{
"name": "src-id",
"definition": "http://hl7.org/fhir/SearchParameter/messageheader-src-id",
"type": "token",
"documentation": "Id of this message"
},
{
"name": "destination",
"definition": "http://hl7.org/fhir/SearchParameter/messageheader-destination",
"type": "string",
"documentation": "Name of system"
}
]
},
{
"type": "NamingSystem",
"profile": {
"reference": "http://hl7.org/fhir/NamingSystem"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
]
},
{
"type": "NutritionOrder",
"profile": {
"reference": "http://hl7.org/fhir/NutritionOrder"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/nutritionorder-patient",
"type": "reference",
"documentation": "The identity of the person who requires the diet, formula or nutritional supplement"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/nutritionorder-status",
"type": "token",
"documentation": "Status of the nutrition order."
},
{
"name": "supplement",
"definition": "http://hl7.org/fhir/SearchParameter/nutritionorder-supplement",
"type": "token",
"documentation": "Type of supplement product requested"
},
{
"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": "provider",
"definition": "http://hl7.org/fhir/SearchParameter/nutritionorder-provider",
"type": "reference",
"documentation": "The identify of the provider who placed the nutrition order"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/nutritionorder-encounter",
"type": "reference",
"documentation": "Return nutrition orders with this encounter identity"
},
{
"name": "datetime",
"definition": "http://hl7.org/fhir/SearchParameter/nutritionorder-datetime",
"type": "date",
"documentation": "Return nutrition orders requested on this date"
},
{
"name": "additive",
"definition": "http://hl7.org/fhir/SearchParameter/nutritionorder-additive",
"type": "token",
"documentation": "Type of module component to add to the feeding"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/nutritionorder-identifier",
"type": "token",
"documentation": "Return nutrition orders with this external identity"
},
{
"name": "formula",
"definition": "http://hl7.org/fhir/SearchParameter/nutritionorder-formula",
"type": "token",
"documentation": "Type of enteral or infant formula"
}
]
},
{
"type": "Observation",
"profile": {
"reference": "http://hl7.org/fhir/Observation"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"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": "status",
"definition": "http://hl7.org/fhir/SearchParameter/observation-status",
"type": "token",
"documentation": "The status of the observation"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/observation-subject",
"type": "reference",
"documentation": "The subject that the observation is about"
},
{
"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": "reliability",
"definition": "http://hl7.org/fhir/SearchParameter/observation-reliability",
"type": "token",
"documentation": "The reliability of the observation"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/observation-encounter",
"type": "reference",
"documentation": "Healthcare event related to the observation"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/observation-code",
"type": "token",
"documentation": "The code of the observation type"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/observation-date",
"type": "date",
"documentation": "Obtained date/time. If the obtained element is a period, a date that falls in the period"
},
{
"name": "related-target",
"definition": "http://hl7.org/fhir/SearchParameter/observation-related-target",
"type": "reference",
"documentation": "Observation that is related to this one"
},
{
"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": "related",
"definition": "http://hl7.org/fhir/SearchParameter/observation-related",
"type": "composite",
"documentation": "Related Observations - search on related-type and related-target together"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/observation-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": "device",
"definition": "http://hl7.org/fhir/SearchParameter/observation-device",
"type": "reference",
"documentation": "The Device that generated the observation data."
},
{
"name": "related-type",
"definition": "http://hl7.org/fhir/SearchParameter/observation-related-type",
"type": "token",
"documentation": "has-component | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by"
},
{
"name": "performer",
"definition": "http://hl7.org/fhir/SearchParameter/observation-performer",
"type": "reference",
"documentation": "Who performed the observation"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/observation-identifier",
"type": "token",
"documentation": "The unique Id for a particular 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": "code-value-[x]",
"definition": "http://hl7.org/fhir/SearchParameter/observation-code-value",
"type": "composite",
"documentation": "Both code and one of the value parameters"
},
{
"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 Period"
}
]
},
{
"type": "OperationDefinition",
"profile": {
"reference": "http://hl7.org/fhir/OperationDefinition"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/operationdefinition-status",
"type": "token",
"documentation": "draft | active | retired"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/operationdefinition-code",
"type": "token",
"documentation": "Name used to invoke the operation"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/operationdefinition-date",
"type": "date",
"documentation": "Date for this version of the operation definition"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/operationdefinition-type",
"type": "token",
"documentation": "Invoke at resource level for these type"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/operationdefinition-url",
"type": "token",
"documentation": "Logical url to reference this operation definition"
},
{
"name": "kind",
"definition": "http://hl7.org/fhir/SearchParameter/operationdefinition-kind",
"type": "token",
"documentation": "operation | query"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/operationdefinition-version",
"type": "token",
"documentation": "Logical id for this version of the operation definition"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/operationdefinition-publisher",
"type": "string",
"documentation": "Name of the publisher (Organization or individual)"
},
{
"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": "Informal name for this profile"
},
{
"name": "base",
"definition": "http://hl7.org/fhir/SearchParameter/operationdefinition-base",
"type": "reference",
"documentation": "Marks this as a profile of the base"
},
{
"name": "instance",
"definition": "http://hl7.org/fhir/SearchParameter/operationdefinition-instance",
"type": "token",
"documentation": "Invoke on an instance?"
},
{
"name": "profile",
"definition": "http://hl7.org/fhir/SearchParameter/operationdefinition-profile",
"type": "reference",
"documentation": "Profile on the type"
}
]
},
{
"type": "OperationOutcome",
"profile": {
"reference": "http://hl7.org/fhir/OperationOutcome"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
]
},
{
"type": "OralHealthClaim",
"profile": {
"reference": "http://hl7.org/fhir/OralHealthClaim"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/oralhealthclaim-patient",
"type": "reference",
"documentation": "Patient"
},
{
"name": "priority",
"definition": "http://hl7.org/fhir/SearchParameter/oralhealthclaim-priority",
"type": "token",
"documentation": "Processing priority requested"
},
{
"name": "use",
"definition": "http://hl7.org/fhir/SearchParameter/oralhealthclaim-use",
"type": "token",
"documentation": "The kind of financial resource"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/oralhealthclaim-identifier",
"type": "token",
"documentation": "The primary identifier of the financial resource"
}
]
},
{
"type": "Order",
"profile": {
"reference": "http://hl7.org/fhir/Order"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "authority",
"definition": "http://hl7.org/fhir/SearchParameter/order-authority",
"type": "reference",
"documentation": "If required by policy"
},
{
"name": "detail",
"definition": "http://hl7.org/fhir/SearchParameter/order-detail",
"type": "reference",
"documentation": "What action is being ordered"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/order-patient",
"type": "reference",
"documentation": "Patient this order is about"
},
{
"name": "source",
"definition": "http://hl7.org/fhir/SearchParameter/order-source",
"type": "reference",
"documentation": "Who initiated the order"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/order-subject",
"type": "reference",
"documentation": "Patient this order is about"
},
{
"name": "when",
"definition": "http://hl7.org/fhir/SearchParameter/order-when",
"type": "date",
"documentation": "A formal schedule"
},
{
"name": "target",
"definition": "http://hl7.org/fhir/SearchParameter/order-target",
"type": "reference",
"documentation": "Who is intended to fulfill the order"
},
{
"name": "when_code",
"definition": "http://hl7.org/fhir/SearchParameter/order-when_code",
"type": "token",
"documentation": "Code specifies when request should be done. The code may simply be a priority code"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/order-date",
"type": "date",
"documentation": "When the order was made"
}
]
},
{
"type": "OrderResponse",
"profile": {
"reference": "http://hl7.org/fhir/OrderResponse"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/orderresponse-patient",
"type": "reference",
"documentation": "The patient the reuqest order is related to"
},
{
"name": "fulfillment",
"definition": "http://hl7.org/fhir/SearchParameter/orderresponse-fulfillment",
"type": "reference",
"documentation": "Details of the outcome of performing the order"
},
{
"name": "request",
"definition": "http://hl7.org/fhir/SearchParameter/orderresponse-request",
"type": "reference",
"documentation": "The order that this is a response to"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/orderresponse-code",
"type": "token",
"documentation": "pending | review | rejected | error | accepted | cancelled | replaced | aborted | complete"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/orderresponse-date",
"type": "date",
"documentation": "When the response was made"
},
{
"name": "who",
"definition": "http://hl7.org/fhir/SearchParameter/orderresponse-who",
"type": "reference",
"documentation": "Who made the response"
}
]
},
{
"type": "Organization",
"profile": {
"reference": "http://hl7.org/fhir/Organization"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"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": "partof",
"definition": "http://hl7.org/fhir/SearchParameter/organization-partof",
"type": "reference",
"documentation": "Search all organizations that are part of the given organization"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/organization-name",
"type": "string",
"documentation": "A portion of the organization's name"
},
{
"name": "active",
"definition": "http://hl7.org/fhir/SearchParameter/organization-active",
"type": "token",
"documentation": "Whether the organization's record is active"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/organization-type",
"type": "token",
"documentation": "A code for the type of organization"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/organization-identifier",
"type": "token",
"documentation": "Any identifier for the organization (not the accreditation issuer's identifier)"
}
]
},
{
"type": "Other",
"profile": {
"reference": "http://hl7.org/fhir/Other"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/other-patient",
"type": "reference",
"documentation": "Identifies the"
},
{
"name": "created",
"definition": "http://hl7.org/fhir/SearchParameter/other-created",
"type": "date",
"documentation": "When created"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/other-subject",
"type": "reference",
"documentation": "Identifies the"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/other-code",
"type": "token",
"documentation": "Kind of Resource"
}
]
},
{
"type": "Patient",
"profile": {
"reference": "http://hl7.org/fhir/Patient"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "animal-breed",
"definition": "http://hl7.org/fhir/SearchParameter/patient-animal-breed",
"type": "token",
"documentation": "The breed for animal patients"
},
{
"name": "phonetic",
"definition": "http://hl7.org/fhir/SearchParameter/patient-phonetic",
"type": "string",
"documentation": "A portion of either family or given name using some kind of phonetic matching algorithm"
},
{
"name": "link",
"definition": "http://hl7.org/fhir/SearchParameter/patient-link",
"type": "reference",
"documentation": "All patients linked to the given patient"
},
{
"name": "animal-species",
"definition": "http://hl7.org/fhir/SearchParameter/patient-animal-species",
"type": "token",
"documentation": "The species for animal patients"
},
{
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/patient-organization",
"type": "reference",
"documentation": "The organization at which this person is a patient"
},
{
"name": "given",
"definition": "http://hl7.org/fhir/SearchParameter/patient-given",
"type": "string",
"documentation": "A portion of the given name of the patient"
},
{
"name": "careprovider",
"definition": "http://hl7.org/fhir/SearchParameter/patient-careprovider",
"type": "reference",
"documentation": "Patient's nominated care provider, could be a care manager, not the organization that manages the record"
},
{
"name": "address",
"definition": "http://hl7.org/fhir/SearchParameter/patient-address",
"type": "string",
"documentation": "An address in any kind of address/part of the patient"
},
{
"name": "family",
"definition": "http://hl7.org/fhir/SearchParameter/patient-family",
"type": "string",
"documentation": "A portion of the family name of the patient"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/patient-name",
"type": "string",
"documentation": "A portion of either family or given name of the patient"
},
{
"name": "telecom",
"definition": "http://hl7.org/fhir/SearchParameter/patient-telecom",
"type": "string",
"documentation": "The value in any kind of telecom details of the patient"
},
{
"name": "birthdate",
"definition": "http://hl7.org/fhir/SearchParameter/patient-birthdate",
"type": "date",
"documentation": "The patient's date of birth"
},
{
"name": "gender",
"definition": "http://hl7.org/fhir/SearchParameter/patient-gender",
"type": "token",
"documentation": "Gender of the patient"
},
{
"name": "active",
"definition": "http://hl7.org/fhir/SearchParameter/patient-active",
"type": "token",
"documentation": "Whether the patient record is active"
},
{
"name": "language",
"definition": "http://hl7.org/fhir/SearchParameter/patient-language",
"type": "token",
"documentation": "Language code (irrespective of use value)"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/patient-identifier",
"type": "token",
"documentation": "A patient identifier"
}
]
},
{
"type": "PaymentNotice",
"profile": {
"reference": "http://hl7.org/fhir/PaymentNotice"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/paymentnotice-identifier",
"type": "token",
"documentation": "The business identifier of the Eligibility"
}
]
},
{
"type": "PaymentReconciliation",
"profile": {
"reference": "http://hl7.org/fhir/PaymentReconciliation"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/paymentreconciliation-identifier",
"type": "token",
"documentation": "The business identifier of the Explanation of Benefit"
}
]
},
{
"type": "PendedRequest",
"profile": {
"reference": "http://hl7.org/fhir/PendedRequest"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/pendedrequest-identifier",
"type": "token",
"documentation": "The business identifier of the Eligibility"
}
]
},
{
"type": "Person",
"profile": {
"reference": "http://hl7.org/fhir/Person"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/person-organization",
"type": "reference",
"documentation": "The organization at which this person record is being managed"
},
{
"name": "phonetic",
"definition": "http://hl7.org/fhir/SearchParameter/person-phonetic",
"type": "string",
"documentation": "A portion of name using some kind of phonetic matching algorithm"
},
{
"name": "address",
"definition": "http://hl7.org/fhir/SearchParameter/person-address",
"type": "string",
"documentation": "An address in any kind of address/part"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/person-name",
"type": "string",
"documentation": "A portion of name in any name part"
},
{
"name": "birthdate",
"definition": "http://hl7.org/fhir/SearchParameter/person-birthdate",
"type": "date",
"documentation": "The person's date of birth"
},
{
"name": "telecom",
"definition": "http://hl7.org/fhir/SearchParameter/person-telecom",
"type": "string",
"documentation": "The value in any kind of contact"
},
{
"name": "gender",
"definition": "http://hl7.org/fhir/SearchParameter/person-gender",
"type": "token",
"documentation": "The gender of the person"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/person-identifier",
"type": "token",
"documentation": "A person Identifier"
}
]
},
{
"type": "PharmacyClaim",
"profile": {
"reference": "http://hl7.org/fhir/PharmacyClaim"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/pharmacyclaim-patient",
"type": "reference",
"documentation": "Patient"
},
{
"name": "priority",
"definition": "http://hl7.org/fhir/SearchParameter/pharmacyclaim-priority",
"type": "token",
"documentation": "Processing priority requested"
},
{
"name": "use",
"definition": "http://hl7.org/fhir/SearchParameter/pharmacyclaim-use",
"type": "token",
"documentation": "The kind of financial resource"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/pharmacyclaim-identifier",
"type": "token",
"documentation": "The primary identifier of the financial resource"
}
]
},
{
"type": "Practitioner",
"profile": {
"reference": "http://hl7.org/fhir/Practitioner"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "phonetic",
"definition": "http://hl7.org/fhir/SearchParameter/practitioner-phonetic",
"type": "string",
"documentation": "A portion of either family or given name using some kind of phonetic matching algorithm"
},
{
"name": "communication",
"definition": "http://hl7.org/fhir/SearchParameter/practitioner-communication",
"type": "token",
"documentation": "One of the languages that the practitioner can communicate with"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/practitioner-location",
"type": "reference",
"documentation": "One of the locations at which this practitioner provides care"
},
{
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/practitioner-organization",
"type": "reference",
"documentation": "The identity of the organization the practitioner represents / acts on behalf of"
},
{
"name": "given",
"definition": "http://hl7.org/fhir/SearchParameter/practitioner-given",
"type": "string",
"documentation": "A portion of the given name"
},
{
"name": "address",
"definition": "http://hl7.org/fhir/SearchParameter/practitioner-address",
"type": "string",
"documentation": "An address in any kind of address/part"
},
{
"name": "family",
"definition": "http://hl7.org/fhir/SearchParameter/practitioner-family",
"type": "string",
"documentation": "A portion of the family name"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/practitioner-name",
"type": "string",
"documentation": "A portion of either family or given name"
},
{
"name": "telecom",
"definition": "http://hl7.org/fhir/SearchParameter/practitioner-telecom",
"type": "string",
"documentation": "The value in any kind of contact"
},
{
"name": "gender",
"definition": "http://hl7.org/fhir/SearchParameter/practitioner-gender",
"type": "token",
"documentation": "Gender of the practitioner"
},
{
"name": "role",
"definition": "http://hl7.org/fhir/SearchParameter/practitioner-role",
"type": "token",
"documentation": "The practitioner can perform this role at for the organization"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/practitioner-identifier",
"type": "token",
"documentation": "A practitioner's Identifier"
},
{
"name": "specialty",
"definition": "http://hl7.org/fhir/SearchParameter/practitioner-specialty",
"type": "token",
"documentation": "The practitioner has this specailty at an organization"
}
]
},
{
"type": "Procedure",
"profile": {
"reference": "http://hl7.org/fhir/Procedure"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/procedure-patient",
"type": "reference",
"documentation": "The identity of a patient to list procedures for"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/procedure-date",
"type": "date",
"documentation": "The date the procedure was performed on"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/procedure-type",
"type": "token",
"documentation": "Type of procedure"
}
]
},
{
"type": "ProcedureRequest",
"profile": {
"reference": "http://hl7.org/fhir/ProcedureRequest"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/procedurerequest-patient",
"type": "reference",
"documentation": "Search by subject - a patient"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/procedurerequest-subject",
"type": "reference",
"documentation": "Search by subject"
}
]
},
{
"type": "ProfessionalClaim",
"profile": {
"reference": "http://hl7.org/fhir/ProfessionalClaim"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/professionalclaim-patient",
"type": "reference",
"documentation": "Patient"
},
{
"name": "priority",
"definition": "http://hl7.org/fhir/SearchParameter/professionalclaim-priority",
"type": "token",
"documentation": "Processing priority requested"
},
{
"name": "use",
"definition": "http://hl7.org/fhir/SearchParameter/professionalclaim-use",
"type": "token",
"documentation": "The kind of financial resource"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/professionalclaim-identifier",
"type": "token",
"documentation": "The primary identifier of the financial resource"
}
]
},
{
"type": "Profile",
"profile": {
"reference": "http://hl7.org/fhir/Profile"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "valueset",
"definition": "http://hl7.org/fhir/SearchParameter/profile-valueset",
"type": "reference",
"documentation": "A vocabulary binding code"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/profile-status",
"type": "token",
"documentation": "The current status of the profile"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/profile-description",
"type": "string",
"documentation": "Text search in the description of the profile"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/profile-name",
"type": "string",
"documentation": "Name of the profile"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/profile-code",
"type": "token",
"documentation": "A code for the profile"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/profile-type",
"type": "token",
"documentation": "Type of resource that is constrained in the profile"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/profile-date",
"type": "date",
"documentation": "The profile publication date"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/profile-identifier",
"type": "token",
"documentation": "The identifier of the profile"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/profile-url",
"type": "token",
"documentation": "Literal URL used to reference this profile"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/profile-publisher",
"type": "string",
"documentation": "Name of the publisher of the profile"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/profile-version",
"type": "token",
"documentation": "The version identifier of the profile"
}
]
},
{
"type": "Provenance",
"profile": {
"reference": "http://hl7.org/fhir/Provenance"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/provenance-patient",
"type": "reference",
"documentation": "A patient that the target resource(s) refer to"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/provenance-location",
"type": "reference",
"documentation": "Where the activity occurred, if relevant"
},
{
"name": "start",
"definition": "http://hl7.org/fhir/SearchParameter/provenance-start",
"type": "date",
"documentation": "Starting time with inclusive boundary"
},
{
"name": "partytype",
"definition": "http://hl7.org/fhir/SearchParameter/provenance-partytype",
"type": "token",
"documentation": "e.g. Resource | Person | Application | Record | Document +"
},
{
"name": "target",
"definition": "http://hl7.org/fhir/SearchParameter/provenance-target",
"type": "reference",
"documentation": "Target Reference(s) (usually version specific)"
},
{
"name": "party",
"definition": "http://hl7.org/fhir/SearchParameter/provenance-party",
"type": "token",
"documentation": "Identity of agent (urn or url)"
},
{
"name": "end",
"definition": "http://hl7.org/fhir/SearchParameter/provenance-end",
"type": "date",
"documentation": "End time with inclusive boundary, if not ongoing"
}
]
},
{
"type": "Questionnaire",
"profile": {
"reference": "http://hl7.org/fhir/Questionnaire"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/questionnaire-title",
"type": "string",
"documentation": "All or part of the name of the questionnaire (title for the root group of the questionnaire)"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/questionnaire-status",
"type": "token",
"documentation": "The status of the questionnaire"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/questionnaire-code",
"type": "token",
"documentation": "A code that corresponds to the questionnaire or one of its groups"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/questionnaire-date",
"type": "date",
"documentation": "When the questionnaire was last changed"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/questionnaire-identifier",
"type": "token",
"documentation": "An identifier for the questionnaire"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/questionnaire-version",
"type": "string",
"documentation": "The business version of the questionnaire"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/questionnaire-publisher",
"type": "string",
"documentation": "The author of the questionnaire"
}
]
},
{
"type": "QuestionnaireAnswers",
"profile": {
"reference": "http://hl7.org/fhir/QuestionnaireAnswers"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "author",
"definition": "http://hl7.org/fhir/SearchParameter/questionnaireanswers-author",
"type": "reference",
"documentation": "The author of the questionnaire"
},
{
"name": "questionnaire",
"definition": "http://hl7.org/fhir/SearchParameter/questionnaireanswers-questionnaire",
"type": "reference",
"documentation": "The questionnaire the answers are provided for"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/questionnaireanswers-patient",
"type": "reference",
"documentation": "The patient that is the subject of the questionnaire"
},
{
"name": "authored",
"definition": "http://hl7.org/fhir/SearchParameter/questionnaireanswers-authored",
"type": "date",
"documentation": "When the questionnaire was authored"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/questionnaireanswers-status",
"type": "token",
"documentation": "The status of the questionnaire answers"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/questionnaireanswers-subject",
"type": "reference",
"documentation": "The subject of the questionnaire"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/questionnaireanswers-encounter",
"type": "reference",
"documentation": "Encounter during which questionnaire was authored"
}
]
},
{
"type": "Readjudicate",
"profile": {
"reference": "http://hl7.org/fhir/Readjudicate"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/readjudicate-identifier",
"type": "token",
"documentation": "The business identifier of the Eligibility"
}
]
},
{
"type": "ReferralRequest",
"profile": {
"reference": "http://hl7.org/fhir/ReferralRequest"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/referralrequest-patient",
"type": "reference",
"documentation": "Who the referral is about"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/referralrequest-status",
"type": "token",
"documentation": "The status of the referral"
},
{
"name": "priority",
"definition": "http://hl7.org/fhir/SearchParameter/referralrequest-priority",
"type": "token",
"documentation": "The priority assigned to the referral"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/referralrequest-type",
"type": "token",
"documentation": "The type of the referral"
},
{
"name": "specialty",
"definition": "http://hl7.org/fhir/SearchParameter/referralrequest-specialty",
"type": "token",
"documentation": "The specialty that the referral is for"
},
{
"name": "recipient",
"definition": "http://hl7.org/fhir/SearchParameter/referralrequest-recipient",
"type": "reference",
"documentation": "The person that the referral was sent to"
}
]
},
{
"type": "RelatedPerson",
"profile": {
"reference": "http://hl7.org/fhir/RelatedPerson"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/relatedperson-patient",
"type": "reference",
"documentation": "The patient this person is related to"
},
{
"name": "phonetic",
"definition": "http://hl7.org/fhir/SearchParameter/relatedperson-phonetic",
"type": "string",
"documentation": "A portion of name using some kind of phonetic matching algorithm"
},
{
"name": "address",
"definition": "http://hl7.org/fhir/SearchParameter/relatedperson-address",
"type": "string",
"documentation": "An address in any kind of address/part"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/relatedperson-name",
"type": "string",
"documentation": "A portion of name in any name part"
},
{
"name": "telecom",
"definition": "http://hl7.org/fhir/SearchParameter/relatedperson-telecom",
"type": "string",
"documentation": "The value in any kind of contact"
},
{
"name": "gender",
"definition": "http://hl7.org/fhir/SearchParameter/relatedperson-gender",
"type": "token",
"documentation": "Gender of the person"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/relatedperson-identifier",
"type": "token",
"documentation": "A patient Identifier"
}
]
},
{
"type": "Reversal",
"profile": {
"reference": "http://hl7.org/fhir/Reversal"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/reversal-identifier",
"type": "token",
"documentation": "The business identifier of the Eligibility"
}
]
},
{
"type": "RiskAssessment",
"profile": {
"reference": "http://hl7.org/fhir/RiskAssessment"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/riskassessment-patient",
"type": "reference",
"documentation": "Who/what does assessment apply to?"
},
{
"name": "condition",
"definition": "http://hl7.org/fhir/SearchParameter/riskassessment-condition",
"type": "reference",
"documentation": "Condition assessed"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/riskassessment-subject",
"type": "reference",
"documentation": "Who/what does assessment apply to?"
},
{
"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": "date",
"definition": "http://hl7.org/fhir/SearchParameter/riskassessment-date",
"type": "date",
"documentation": "When was assessment made?"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/riskassessment-identifier",
"type": "token",
"documentation": "Unique identifier for the assessment"
}
]
},
{
"type": "Schedule",
"profile": {
"reference": "http://hl7.org/fhir/Schedule"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"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": "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/SearchParameter"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/searchparameter-description",
"type": "string",
"documentation": "Documentation for search parameter"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/searchparameter-name",
"type": "string",
"documentation": "Name of search parameter"
},
{
"name": "target",
"definition": "http://hl7.org/fhir/SearchParameter/searchparameter-target",
"type": "token",
"documentation": "Types of resource (if a resource reference)"
},
{
"name": "base",
"definition": "http://hl7.org/fhir/SearchParameter/searchparameter-base",
"type": "token",
"documentation": "The resource type this search parameter applies to"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/searchparameter-type",
"type": "token",
"documentation": "number | date | string | token | reference | composite | quantity"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/searchparameter-url",
"type": "token",
"documentation": "Literal URL used to reference this search parameter"
}
]
},
{
"type": "SecurityEvent",
"profile": {
"reference": "http://hl7.org/fhir/SecurityEvent"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "site",
"definition": "http://hl7.org/fhir/SearchParameter/securityevent-site",
"type": "token",
"documentation": "Logical source location within the enterprise"
},
{
"name": "desc",
"definition": "http://hl7.org/fhir/SearchParameter/securityevent-desc",
"type": "string",
"documentation": "Instance-specific descriptor for Object"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/securityevent-type",
"type": "token",
"documentation": "Type/identifier of event"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/securityevent-date",
"type": "date",
"documentation": "Time when the event occurred on source"
},
{
"name": "reference",
"definition": "http://hl7.org/fhir/SearchParameter/securityevent-reference",
"type": "reference",
"documentation": "Specific instance of resource (e.g. versioned)"
},
{
"name": "identity",
"definition": "http://hl7.org/fhir/SearchParameter/securityevent-identity",
"type": "token",
"documentation": "Specific instance of object (e.g. versioned)"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/securityevent-patient",
"type": "reference",
"documentation": "A patient that the .object.reference refers to"
},
{
"name": "altid",
"definition": "http://hl7.org/fhir/SearchParameter/securityevent-altid",
"type": "token",
"documentation": "Alternative User id e.g. authentication"
},
{
"name": "patientid",
"definition": "http://hl7.org/fhir/SearchParameter/securityevent-patientid",
"type": "token",
"documentation": "The id of the patient (one of multiple kinds of participations)"
},
{
"name": "source",
"definition": "http://hl7.org/fhir/SearchParameter/securityevent-source",
"type": "token",
"documentation": "The id of source where event originated"
},
{
"name": "address",
"definition": "http://hl7.org/fhir/SearchParameter/securityevent-address",
"type": "token",
"documentation": "Identifier for the network access point of the user device"
},
{
"name": "subtype",
"definition": "http://hl7.org/fhir/SearchParameter/securityevent-subtype",
"type": "token",
"documentation": "More specific type/id for the event"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/securityevent-name",
"type": "string",
"documentation": "Human-meaningful name for the user"
},
{
"name": "action",
"definition": "http://hl7.org/fhir/SearchParameter/securityevent-action",
"type": "token",
"documentation": "Type of action performed during the event"
},
{
"name": "object-type",
"definition": "http://hl7.org/fhir/SearchParameter/securityevent-object-type",
"type": "token",
"documentation": "Object type being audited"
},
{
"name": "user",
"definition": "http://hl7.org/fhir/SearchParameter/securityevent-user",
"type": "token",
"documentation": "Unique identifier for the user"
}
]
},
{
"type": "Slot",
"profile": {
"reference": "http://hl7.org/fhir/Slot"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"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": "start",
"definition": "http://hl7.org/fhir/SearchParameter/slot-start",
"type": "date",
"documentation": "Appointment date/time."
},
{
"name": "slottype",
"definition": "http://hl7.org/fhir/SearchParameter/slot-slottype",
"type": "token",
"documentation": "The type of appointments that can be booked into the slot"
},
{
"name": "fbtype",
"definition": "http://hl7.org/fhir/SearchParameter/slot-fbtype",
"type": "token",
"documentation": "The free/busy status of the appointment"
}
]
},
{
"type": "Specimen",
"profile": {
"reference": "http://hl7.org/fhir/Specimen"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "site",
"definition": "http://hl7.org/fhir/SearchParameter/specimen-site",
"type": "token",
"documentation": "The source or body site from where the specimen came"
},
{
"name": "collector",
"definition": "http://hl7.org/fhir/SearchParameter/specimen-collector",
"type": "reference",
"documentation": "Who collected the specimen"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/specimen-patient",
"type": "reference",
"documentation": "The patient the specimen comes from"
},
{
"name": "container",
"definition": "http://hl7.org/fhir/SearchParameter/specimen-container",
"type": "token",
"documentation": "The kind of specimen container"
},
{
"name": "collected",
"definition": "http://hl7.org/fhir/SearchParameter/specimen-collected",
"type": "date",
"documentation": "The date the specimen was collected"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/specimen-subject",
"type": "reference",
"documentation": "The subject of the specimen"
},
{
"name": "containerid",
"definition": "http://hl7.org/fhir/SearchParameter/specimen-containerid",
"type": "token",
"documentation": "The unique identifier associated with the specimen container"
},
{
"name": "accession",
"definition": "http://hl7.org/fhir/SearchParameter/specimen-accession",
"type": "token",
"documentation": "The accession number associated with the specimen"
},
{
"name": "parent",
"definition": "http://hl7.org/fhir/SearchParameter/specimen-parent",
"type": "reference",
"documentation": "The parent of the specimen"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/specimen-type",
"type": "token",
"documentation": "The specimen type"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/specimen-identifier",
"type": "token",
"documentation": "The unique identifier associated with the specimen"
}
]
},
{
"type": "StatusRequest",
"profile": {
"reference": "http://hl7.org/fhir/StatusRequest"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/statusrequest-identifier",
"type": "token",
"documentation": "The business identifier of the Eligibility"
}
]
},
{
"type": "StatusResponse",
"profile": {
"reference": "http://hl7.org/fhir/StatusResponse"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/statusresponse-identifier",
"type": "token",
"documentation": "The business identifier of the Explanation of Benefit"
}
]
},
{
"type": "StructureDefinition",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "valueset",
"definition": "http://hl7.org/fhir/SearchParameter/structuredefinition-valueset",
"type": "reference",
"documentation": "A vocabulary binding code"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/structuredefinition-status",
"type": "token",
"documentation": "The current status of the profile"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/structuredefinition-description",
"type": "string",
"documentation": "Text search in the description of the profile"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/structuredefinition-name",
"type": "string",
"documentation": "Name of the profile"
},
{
"name": "path",
"definition": "http://hl7.org/fhir/SearchParameter/structuredefinition-path",
"type": "token",
"documentation": "A path that is constrained in the profile"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/structuredefinition-code",
"type": "token",
"documentation": "A code for the profile"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/structuredefinition-type",
"type": "token",
"documentation": "abstract | type | resource | constraint | extension"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/structuredefinition-date",
"type": "date",
"documentation": "The profile publication date"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/structuredefinition-identifier",
"type": "token",
"documentation": "The identifier of the profile"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/structuredefinition-url",
"type": "token",
"documentation": "Literal URL used to reference this profile"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/structuredefinition-publisher",
"type": "string",
"documentation": "Name of the publisher of the profile"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/structuredefinition-version",
"type": "token",
"documentation": "The version identifier of the profile"
}
]
},
{
"type": "Subscription",
"profile": {
"reference": "http://hl7.org/fhir/Subscription"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "criteria",
"definition": "http://hl7.org/fhir/SearchParameter/subscription-criteria",
"type": "string",
"documentation": "Rule for server push criteria"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/subscription-status",
"type": "token",
"documentation": "requested | active | error | off"
},
{
"name": "tag",
"definition": "http://hl7.org/fhir/SearchParameter/subscription-tag",
"type": "string",
"documentation": "The term that identifies the tag"
},
{
"name": "payload",
"definition": "http://hl7.org/fhir/SearchParameter/subscription-payload",
"type": "string",
"documentation": "Mimetype to send, or blank for no payload"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/subscription-type",
"type": "token",
"documentation": "rest-hook | websocket | email | sms | message"
},
{
"name": "contact",
"definition": "http://hl7.org/fhir/SearchParameter/subscription-contact",
"type": "token",
"documentation": "Contact details for source (e.g. troubleshooting)"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/subscription-url",
"type": "string",
"documentation": "Where the channel points to"
}
]
},
{
"type": "Substance",
"profile": {
"reference": "http://hl7.org/fhir/Substance"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "substance",
"definition": "http://hl7.org/fhir/SearchParameter/substance-substance",
"type": "reference",
"documentation": "A component of the substance"
},
{
"name": "quantity",
"definition": "http://hl7.org/fhir/SearchParameter/substance-quantity",
"type": "number",
"documentation": "Amount of substance in the package"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/substance-type",
"type": "token",
"documentation": "The type of the substance"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/substance-identifier",
"type": "token",
"documentation": "Identifier of the package/container"
},
{
"name": "expiry",
"definition": "http://hl7.org/fhir/SearchParameter/substance-expiry",
"type": "date",
"documentation": "When no longer valid to use"
}
]
},
{
"type": "Supply",
"profile": {
"reference": "http://hl7.org/fhir/Supply"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/supply-patient",
"type": "reference",
"documentation": "Patient for whom the item is supplied"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/supply-status",
"type": "token",
"documentation": "requested | dispensed | received | failed | cancelled"
},
{
"name": "dispenseid",
"definition": "http://hl7.org/fhir/SearchParameter/supply-dispenseid",
"type": "token",
"documentation": "External identifier"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/supply-identifier",
"type": "token",
"documentation": "Unique identifier"
},
{
"name": "supplier",
"definition": "http://hl7.org/fhir/SearchParameter/supply-supplier",
"type": "reference",
"documentation": "Dispenser"
},
{
"name": "kind",
"definition": "http://hl7.org/fhir/SearchParameter/supply-kind",
"type": "token",
"documentation": "The kind of supply (central, non-stock, etc)"
},
{
"name": "dispensestatus",
"definition": "http://hl7.org/fhir/SearchParameter/supply-dispensestatus",
"type": "token",
"documentation": "in-progress | dispensed | abandoned"
}
]
},
{
"type": "SupportingDocumentation",
"profile": {
"reference": "http://hl7.org/fhir/SupportingDocumentation"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "author",
"definition": "http://hl7.org/fhir/SearchParameter/supportingdocumentation-author",
"type": "reference",
"documentation": "The person who generated this resource"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/supportingdocumentation-patient",
"type": "reference",
"documentation": "The patient to whom the documents refer"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/supportingdocumentation-subject",
"type": "reference",
"documentation": "The patient to whom the documents refer"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/supportingdocumentation-identifier",
"type": "token",
"documentation": "The business identifier of the Eligibility"
}
]
},
{
"type": "ValueSet",
"profile": {
"reference": "http://hl7.org/fhir/ValueSet"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "system",
"definition": "http://hl7.org/fhir/SearchParameter/valueset-system",
"type": "token",
"documentation": "The system for any codes defined by this value set"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/valueset-status",
"type": "token",
"documentation": "The status of the value set"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/valueset-description",
"type": "string",
"documentation": "Text search in the description of the value set"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/valueset-name",
"type": "string",
"documentation": "The name of the value set"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/valueset-code",
"type": "token",
"documentation": "A code defined in the value set"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/valueset-date",
"type": "date",
"documentation": "The value set publication date"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/valueset-identifier",
"type": "token",
"documentation": "The identifier for the value set"
},
{
"name": "reference",
"definition": "http://hl7.org/fhir/SearchParameter/valueset-reference",
"type": "token",
"documentation": "A code system included or excluded in the value set or an imported value set"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/valueset-url",
"type": "token",
"documentation": "The logical url for 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": "version",
"definition": "http://hl7.org/fhir/SearchParameter/valueset-version",
"type": "token",
"documentation": "The version identifier of the value set"
}
]
},
{
"type": "VisionClaim",
"profile": {
"reference": "http://hl7.org/fhir/VisionClaim"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/visionclaim-patient",
"type": "reference",
"documentation": "Patient"
},
{
"name": "priority",
"definition": "http://hl7.org/fhir/SearchParameter/visionclaim-priority",
"type": "token",
"documentation": "Processing priority requested"
},
{
"name": "use",
"definition": "http://hl7.org/fhir/SearchParameter/visionclaim-use",
"type": "token",
"documentation": "The kind of financial resource"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/visionclaim-identifier",
"type": "token",
"documentation": "The primary identifier of the financial resource"
}
]
},
{
"type": "VisionPrescription",
"profile": {
"reference": "http://hl7.org/fhir/VisionPrescription"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "datewritten",
"definition": "http://hl7.org/fhir/SearchParameter/visionprescription-datewritten",
"type": "date",
"documentation": "Return prescriptions written on this date"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/visionprescription-patient",
"type": "reference",
"documentation": "The identity of a patient to list dispenses for"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/visionprescription-encounter",
"type": "reference",
"documentation": "Return prescriptions with this encounter identity"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/visionprescription-identifier",
"type": "token",
"documentation": "Return prescriptions with this external identity"
}
]
}
],
"interaction": [
{
"code": "transaction"
},
{
"code": "history-system"
},
{
"code": "search-system"
}
]
}
]
}
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 DSTU (v0.4.0-4167) generated on Mon, Feb 23, 2015 09:17+1100.
Links: What's a DSTU? |
Version History |
Compare to DSTU1 |
|
Propose a change