AppointmentResponse: |
_content | | Search on the entire content of the resource | |
_filter | | This is the formal declaration for the _filter parameter, documented at [http://hl7.org/fhir/search_filter.html](http://hl7.org/fhir/search_filter.html) | |
_id | | Logical id of this artifact | |
_lastUpdated | | When the resource version last changed on given date (yyyy-mm-dd) | |
(before) | | (before given date) | |
(after) | | (after given date) | |
_profile | | Profiles this resource claims to conform to | |
_query | | A custom search profile that describes a specific defined query operation | |
_security | | Security Labels applied to this resource | |
_source | | Identifies where the resource comes from | |
_tag | | Tags applied to this resource | |
_text | | Search on the narrative of the resource | |
identifier | | An Identifier in this appointment response | |
part-status | | The participants acceptance status for this appointment | |
actor (Practitioner / Device / Patient / HealthcareService / PractitionerRole / RelatedPerson / Location): |
_content | | Search on the entire content of the resource | |
_filter | | This is the formal declaration for the _filter parameter, documented at [http://hl7.org/fhir/search_filter.html](http://hl7.org/fhir/search_filter.html) | |
_id | | Logical id of this artifact | |
_lastUpdated (exact) | | When the resource version last changed | |
(before) | | (before given date) |
(after) | | (after given date) |
_profile | | Profiles this resource claims to conform to | |
_query | | A custom search profile that describes a specific defined query operation | |
_security | | Security Labels applied to this resource | |
_source | | Identifies where the resource comes from | |
_tag | | Tags applied to this resource | |
_text | | Search on the narrative of the resource | |
device-name | | A server defined search that may match any of the string fields in Device.deviceName or Device.type. | |
din | | The donation identification number (DIN) | |
identifier | | Instance id from manufacturer, owner, and others | |
location | | A location, where the resource is found | |
manufacturer | | The manufacturer of the device | |
model | | The model of the device | |
organization | | The organization responsible for the device | |
patient | | Patient information, if the resource is affixed to a person | |
status | | active | inactive | entered-in-error | unknown | |
type | | The type of the device | |
udi-carrier | | UDI Barcode (RFID or other technology) string in *HRF* format. | |
udi-di | | The udi Device Identifier (DI) | |
url | | Network address to contact device | |
active | | The Healthcare Service is currently marked as active | |
characteristic | | One of the HealthcareService's characteristics | |
coverage-area | | Location(s) service is intended for/available to | |
endpoint | | Technical endpoints providing access to electronic services operated for the healthcare service | |
name | | A portion of the Healthcare service name | |
program | | One of the Programs supported by this HealthcareService | |
service-category | | Service Category of the Healthcare Service | |
service-type | | The type of service provided by this healthcare service | |
specialty | | The specialty of the service provided by this healthcare service | |
address | | A (part of the) address of the location | |
address-city | | A city specified in an address | |
address-country | | A country specified in an address | |
address-postalcode | | A postal code specified in an address | |
address-state | | A state specified in an address | |
address-use | | A use code specified in an address | |
near | | Search for locations where the location.position is near to, or within a specified distance of, the provided coordinates expressed as [latitude]|[longitude]|[distance]|[units] (using the WGS84 datum, see notes). If the units are omitted, then kms should be assumed. If the distance is omitted, then the server can use its own discretion as to what distances should be considered near (and units are irrelevant) Servers may search using various techniques that might have differing accuracies, depending on implementation efficiency. Requires the near-distance parameter to be provided also | |
operational-status | | Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping) | |
partof | | A location of which this location is a part | |
age | | Searches for patients based on age as calculated based on current date and date of birth. Deceased patients are excluded from the search. | |
birthOrderBoolean | | Search based on whether a patient was part of a multiple birth or not. | |
birthdate (exact) | | The patient's date of birth | |
(before) | | (before given date) |
(after) | | (after given date) |
death-date (exact) | | The date of death has been provided and satisfies this search value | |
(before) | | (before given date) |
(after) | | (after given date) |
deceased | | This patient has been marked as deceased, or as a death date entered | |
email | | A value in an email contact | |
family | | A portion of the family name of the patient | |
gender | | Gender of the patient | |
general-practitioner | | Patient's nominated general practitioner, not the organization that manages the record | |
given | | A portion of the given name of the patient | |
language | | Language code (irrespective of use value) | |
link | | All patients linked to the given patient | |
mothersMaidenName | | Search based on patient's mother's maiden name | |
part-agree | | Search by url for a participation agreement, which is stored in a DocumentReference | |
phone | | A value in a phone contact | |
phonetic | | A portion of either family or given name using some kind of phonetic matching algorithm | |
telecom | | The value in any kind of telecom details of the patient | |
communication | | One of the languages that the practitioner can communicate with | |
date (exact) | | The period during which the practitioner is authorized to perform in these role(s) | |
(before) | | (before given date) |
(after) | | (after given date) |
practitioner | | Practitioner that is able to provide the defined services for the organization | |
role | | The practitioner can perform this role at for the organization | |
service | | The list of healthcare services that this worker provides for this role's Organization/Location(s) | |
relationship | | The relationship between the patient and the relatedperson | |
appointment (Appointment): |
_content | | Search on the entire content of the resource | |
_filter | | This is the formal declaration for the _filter parameter, documented at [http://hl7.org/fhir/search_filter.html](http://hl7.org/fhir/search_filter.html) | |
_id | | Logical id of this artifact | |
_lastUpdated (exact) | | When the resource version last changed | |
(before) | | (before given date) |
(after) | | (after given date) |
_profile | | Profiles this resource claims to conform to | |
_query | | A custom search profile that describes a specific defined query operation | |
_security | | Security Labels applied to this resource | |
_source | | Identifies where the resource comes from | |
_tag | | Tags applied to this resource | |
_text | | Search on the narrative of the resource | |
actor | | Any one of the individuals participating in the appointment | |
appointment-type | | The style of appointment or patient that has been booked in the slot (not service type) | |
based-on | | The service request this appointment is allocated to assess | |
date (exact) | | Appointment date/time. | |
(before) | | (before given date) |
(after) | | (after given date) |
identifier | | An Identifier of the Appointment | |
location | | This location is listed in the participants of the appointment | |
part-status | | The Participation status of the subject, or other participant on the appointment. Can be used to locate participants that have not responded to meeting requests. | |
patient | | One of the individuals of the appointment is this patient | |
practitioner | | One of the individuals of the appointment is this practitioner | |
reason-code | | Coded reason this appointment is scheduled | |
reason-reference | | Reason the appointment is to take place (resource) | |
service-category | | A broad categorization of the service that is to be performed during this appointment | |
service-type | | The specific service that is to be performed during this appointment | |
slot | | The slots that this appointment is filling | |
specialty | | The specialty of a practitioner that would be required to perform the service requested in this appointment | |
status | | The overall status of the appointment | |
supporting-info | | Additional information to support the appointment | |
location (Location): |
_content | | Search on the entire content of the resource | |
_filter | | This is the formal declaration for the _filter parameter, documented at [http://hl7.org/fhir/search_filter.html](http://hl7.org/fhir/search_filter.html) | |
_id | | Logical id of this artifact | |
_lastUpdated (exact) | | When the resource version last changed | |
(before) | | (before given date) |
(after) | | (after given date) |
_profile | | Profiles this resource claims to conform to | |
_query | | A custom search profile that describes a specific defined query operation | |
_security | | Security Labels applied to this resource | |
_source | | Identifies where the resource comes from | |
_tag | | Tags applied to this resource | |
_text | | Search on the narrative of the resource | |
address | | A (part of the) address of the location | |
address-city | | A city specified in an address | |
address-country | | A country specified in an address | |
address-postalcode | | A postal code specified in an address | |
address-state | | A state specified in an address | |
address-use | | A use code specified in an address | |
endpoint | | Technical endpoints providing access to services operated for the location | |
identifier | | An identifier for the location | |
name | | A portion of the location's name or alias | |
near | | Search for locations where the location.position is near to, or within a specified distance of, the provided coordinates expressed as [latitude]|[longitude]|[distance]|[units] (using the WGS84 datum, see notes). If the units are omitted, then kms should be assumed. If the distance is omitted, then the server can use its own discretion as to what distances should be considered near (and units are irrelevant) Servers may search using various techniques that might have differing accuracies, depending on implementation efficiency. Requires the near-distance parameter to be provided also | |
operational-status | | Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping) | |
organization | | Searches for locations that are managed by the provided organization | |
partof | | A location of which this location is a part | |
status | | Searches for locations with a specific kind of status | |
type | | A code for the type of location | |
patient (Patient): |
_content | | Search on the entire content of the resource | |
_filter | | This is the formal declaration for the _filter parameter, documented at [http://hl7.org/fhir/search_filter.html](http://hl7.org/fhir/search_filter.html) | |
_id | | Logical id of this artifact | |
_lastUpdated (exact) | | When the resource version last changed | |
(before) | | (before given date) |
(after) | | (after given date) |
_profile | | Profiles this resource claims to conform to | |
_query | | A custom search profile that describes a specific defined query operation | |
_security | | Security Labels applied to this resource | |
_source | | Identifies where the resource comes from | |
_tag | | Tags applied to this resource | |
_text | | Search on the narrative of the resource | |
active | | Whether the patient record is active | |
address | | A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text | |
address-city | | A city specified in an address | |
address-country | | A country specified in an address | |
address-postalcode | | A postalCode specified in an address | |
address-state | | A state specified in an address | |
address-use | | A use code specified in an address | |
age | | Searches for patients based on age as calculated based on current date and date of birth. Deceased patients are excluded from the search. | |
birthOrderBoolean | | Search based on whether a patient was part of a multiple birth or not. | |
birthdate (exact) | | The patient's date of birth | |
(before) | | (before given date) |
(after) | | (after given date) |
death-date (exact) | | The date of death has been provided and satisfies this search value | |
(before) | | (before given date) |
(after) | | (after given date) |
deceased | | This patient has been marked as deceased, or as a death date entered | |
email | | A value in an email contact | |
family | | A portion of the family name of the patient | |
gender | | Gender of the patient | |
general-practitioner | | Patient's nominated general practitioner, not the organization that manages the record | |
given | | A portion of the given name of the patient | |
identifier | | A patient identifier | |
language | | Language code (irrespective of use value) | |
link | | All patients linked to the given patient | |
mothersMaidenName | | Search based on patient's mother's maiden name | |
name | | A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text | |
organization | | The organization that is the custodian of the patient record | |
part-agree | | Search by url for a participation agreement, which is stored in a DocumentReference | |
phone | | A value in a phone contact | |
phonetic | | A portion of either family or given name using some kind of phonetic matching algorithm | |
telecom | | The value in any kind of telecom details of the patient | |
practitioner (Practitioner): |
_content | | Search on the entire content of the resource | |
_filter | | This is the formal declaration for the _filter parameter, documented at [http://hl7.org/fhir/search_filter.html](http://hl7.org/fhir/search_filter.html) | |
_id | | Logical id of this artifact | |
_lastUpdated (exact) | | When the resource version last changed | |
(before) | | (before given date) |
(after) | | (after given date) |
_profile | | Profiles this resource claims to conform to | |
_query | | A custom search profile that describes a specific defined query operation | |
_security | | Security Labels applied to this resource | |
_source | | Identifies where the resource comes from | |
_tag | | Tags applied to this resource | |
_text | | Search on the narrative of the resource | |
active | | Whether the practitioner record is active | |
address | | A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text | |
address-city | | A city specified in an address | |
address-country | | A country specified in an address | |
address-postalcode | | A postalCode specified in an address | |
address-state | | A state specified in an address | |
address-use | | A use code specified in an address | |
communication | | One of the languages that the practitioner can communicate with | |
email | | A value in an email contact | |
family | | A portion of the family name | |
gender | | Gender of the practitioner | |
given | | A portion of the given name | |
identifier | | A practitioner's Identifier | |
name | | A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text | |
phone | | A value in a phone contact | |
phonetic | | A portion of either family or given name using some kind of phonetic matching algorithm | |
telecom | | The value in any kind of contact | |
|
Text | | Search for these words in the narrative. See [[http://technet.microsoft.com/en-us/library/ms142571.aspx]] for details |
First Record | | (empty = start at the start) |
# Records to return | | (default value, which is also max allowed, is 1000. Values of <2 not allowed) |
Sort By | | |
Summary: | | Return just a summary for each resource (if applicable) |