FHIR RESTful Server - FHIR v4.0.0

FHIR Repository Search

DiagnosticReport:
_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
assessed-condition		Condition assessed by genetic test
category		Which diagnostic discipline/department created the report
code		The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result
conclusion		A coded conclusion (interpretation/impression) on the report
date		The clinically relevant time of the report on given date (yyyy-mm-dd)
(before)		(before given date)
(after)		(after given date)
identifier		An identifier for the report
issued		When the report was issued on given date (yyyy-mm-dd)
(before)		(before given date)
(after)		(after given date)
status		The status of the report
based-on (CarePlan / MedicationRequest / NutritionOrder / ServiceRequest / ImmunizationRecommendation):
_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
activity-code		Detail type of activity
activity-date (exact)		Specified date occurs within period specified by CarePlan.activity.detail.scheduled[x]
(before)		(before given date)
(after)		(after given date)
activity-reference		Activity details defined in specific resource
based-on		Fulfills CarePlan
care-team		Who's involved in plan?
category		Type of plan
condition		Health issues this plan addresses
date (exact)		Time period plan covers
(before)		(before given date)
(after)		(after given date)
encounter		Encounter created as part of
goal		Desired outcome of plan
identifier		External Ids for this plan
instantiates-canonical		Instantiates FHIR protocol or definition
instantiates-uri		Instantiates external protocol or definition
intent		proposal \| plan \| order \| option
part-of		Part of referenced CarePlan
patient		Who the care plan is for
performer		Matches if the practitioner is listed as a performer in any of the "simple" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.)
replaces		CarePlan replaced by this CarePlan
status		draft \| active \| suspended \| completed \| entered-in-error \| cancelled \| unknown
subject		Who the care plan is for
information		Patient observations supporting recommendation
support		Past immunizations supporting recommendation
target-disease		Disease to be immunized against
vaccine-type		Vaccine or vaccine group recommendation applies to
authoredon (exact)		Return prescriptions written on this date
(before)		(before given date)
(after)		(after given date)
code		Return prescriptions of this medication code
intended-dispenser		Returns prescriptions intended to be dispensed by this Organization
intended-performer		Returns the intended performer of the administration of the medication request
intended-performertype		Returns requests for a specific type of performer
medication		Return prescriptions for this medication reference
priority		Returns prescriptions with different priorities
requester		Returns prescriptions prescribed by this prescriber
additive		Type of module component to add to the feeding
datetime (exact)		Return nutrition orders requested on this date
(before)		(before given date)
(after)		(after given date)
formula		Type of enteral or infant formula
oraldiet		Type of diet that can be consumed orally (i.e., take via the mouth).
provider		The identity of the provider who placed the nutrition order
supplement		Type of supplement product requested
authored (exact)		Date request signed
(before)		(before given date)
(after)		(after given date)
body-site		Where procedure is going to be done
occurrence (exact)		When service should occur
(before)		(before given date)
(after)		(after given date)
performer-type		Performer role
requisition		Composite Request ID
specimen		Specimen to be tested
encounter (EpisodeOfCare / Encounter):
_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
account		The set of accounts that may be used for billing for this Encounter
appointment		The appointment that scheduled this encounter
based-on		The ServiceRequest that initiated this encounter
class		Classification of patient encounter
date (exact)		A date within the period the Encounter lasted
(before)		(before given date)
(after)		(after given date)
diagnosis		The diagnosis or procedure relevant to the encounter
episode-of-care		Episode(s) of care that this encounter should be recorded against
identifier		Identifier(s) by which this encounter is known
length		Length of encounter in days
location		Location the encounter takes place
location-period (exact)		Time period during which the patient was present at the location
(before)		(before given date)
(after)		(after given date)
part-of		Another Encounter this encounter is part of
participant		Persons involved in the encounter other than the patient
participant-type		Role of participant in encounter
patient		The patient or group present at the encounter
practitioner		Persons involved in the encounter other than the patient
reason-code		Coded reason the encounter takes place
reason-reference		Reason the encounter takes place (reference)
service-provider		The organization (facility) responsible for this encounter
special-arrangement		Wheelchair, translator, stretcher, etc.
status		planned \| arrived \| triaged \| in-progress \| onleave \| finished \| cancelled +
subject		The patient or group present at the encounter
type		Specific type of encounter
care-manager		Care manager/care coordinator for the patient
condition		Conditions/problems/diagnoses this episode of care is for
incoming-referral		Incoming Referral Request
organization		The organization that has assumed the specific responsibilities of this EpisodeOfCare
media (Media):
_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
based-on		Procedure that caused this media to be created
created (exact)		When Media was collected
(before)		(before given date)
(after)		(after given date)
device		Observing Device
encounter		Encounter associated with media
identifier		Identifier(s) for the image
modality		The type of acquisition equipment/process
operator		The person who generated the image
patient		Who/What this Media is a record of
site		Observed body part
status		preparation \| in-progress \| not-done \| suspended \| aborted \| completed \| entered-in-error \| unknown
subject		Who/What this Media is a record of
type		Classification of media as image, video, or audio
view		Imaging view, e.g. Lateral or Antero-posterior
patient (Group / 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
actual		Descriptive or actual
characteristic		Kind of characteristic
characteristic-value		A composite of both characteristic and value
code		The kind of resources contained
exclude		Group includes or excludes
identifier		Unique id
managing-entity		Entity that is the custodian of the Group's definition
member		Reference to the group member
type		The type of resources the group contains
value		Value held by characteristic
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
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
performer (Practitioner / Organization / CareTeam / PractitionerRole):
_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
category		Type of team
date (exact)		Time period team covers
(before)		(before given date)
(after)		(after given date)
encounter		Encounter created as part of
identifier		External Ids for this team
participant		Who is involved
patient		Who care team is for
status		proposed \| active \| suspended \| inactive \| entered-in-error
subject		Who care team is for
active		Is the Organization record 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 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 organization
name		A portion of the organization's name or alias
partof		An organization of which this organization forms a part
phonetic		A portion of the organization's name using some kind of phonetic matching algorithm
type		A code for the type of organization
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
phone		A value in a phone contact
telecom		The value in any kind of contact
location		One of the locations at which this practitioner provides care
organization		The identity of the organization the practitioner represents / acts on behalf of
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)
specialty		The practitioner has this specialty at an organization
result (Observation):
_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
amino-acid-change		HGVS Protein Change
based-on		Reference to the service request.
category		The classification of the type of observation
code		The code of the observation type
code-value-concept		Code and coded value parameter pair
code-value-date		Code and date/time value parameter pair
code-value-quantity		Code and quantity value parameter pair
code-value-string		Code and string value parameter pair
combo-code		The code of the observation type or component type
combo-code-value-concept		Code and coded value parameter pair, including in components
combo-code-value-quantity		Code and quantity value parameter pair, including in components
combo-data-absent-reason		The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing.
combo-value-concept		The value or component value of the observation, if the value is a CodeableConcept
combo-value-quantity		The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)
component-code		The component code of the observation type
component-code-value-concept		Component code and component coded value parameter pair
component-code-value-quantity		Component code and component quantity value parameter pair
component-data-absent-reason		The reason why the expected value in the element Observation.component.value[x] is missing.
component-value-concept		The value of the component observation, if the value is a CodeableConcept
component-value-quantity		The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)
data-absent-reason		The reason why the expected value in the element Observation.value[x] is missing.
date (exact)		Obtained date/time. If the obtained element is a period, a date that falls in the period
(before)		(before given date)
(after)		(after given date)
derived-from		Related measurements the observation is made from
device		The Device that generated the observation data.
dna-variant		search for extension http://hl7.org/fhir/StructureDefinition/observation-geneticsDNASequenceVariantName
encounter		Encounter related to the observation
focus		The focus of an observation when the focus is not the patient of record.
gene-amino-acid-change		HGNC gene symbol and HGVS Protein change
gene-dnavariant		search for extension http://hl7.org/fhir/StructureDefinition/observation-geneticsDNAVariantId
gene-identifier		search for extension http://hl7.org/fhir/StructureDefinition/observation-geneticsGene
has-member		Related resource that belongs to the Observation group
identifier		The unique id for a particular observation
method		The method used for the observation
part-of		Part of referenced event
patient		The subject that the observation is about (if patient)
performer		Who performed the observation
specimen		Specimen used for this observation
status		The status of the observation
subject		The subject that the observation is about
value-concept		The value of the observation, if the value is a CodeableConcept
value-date (exact)		The value of the observation, if the value is a date or period of time
(before)		(before given date)
(after)		(after given date)
value-quantity		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)
value-string		The value of the observation, if the value is a string, and also searches in CodeableConcept.text
results-interpreter (Practitioner / Organization / CareTeam / PractitionerRole):
_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
category		Type of team
date (exact)		Time period team covers
(before)		(before given date)
(after)		(after given date)
encounter		Encounter created as part of
identifier		External Ids for this team
participant		Who is involved
patient		Who care team is for
status		proposed \| active \| suspended \| inactive \| entered-in-error
subject		Who care team is for
active		Is the Organization record 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 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 organization
name		A portion of the organization's name or alias
partof		An organization of which this organization forms a part
phonetic		A portion of the organization's name using some kind of phonetic matching algorithm
type		A code for the type of organization
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
phone		A value in a phone contact
telecom		The value in any kind of contact
location		One of the locations at which this practitioner provides care
organization		The identity of the organization the practitioner represents / acts on behalf of
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)
specialty		The practitioner has this specialty at an organization
specimen (Specimen):
_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
accession		The accession number associated with the specimen
bodysite		The code for the body site from where the specimen originated
collected (exact)		The date the specimen was collected
(before)		(before given date)
(after)		(after given date)
collector		Who collected the specimen
container		The kind of specimen container
container-id		The unique identifier associated with the specimen container
identifier		The unique identifier associated with the specimen
parent		The parent of the specimen
patient		The patient the specimen comes from
status		available \| unavailable \| unsatisfactory \| entered-in-error
subject		The subject of the specimen
type		The specimen type
subject (Group / Device / Patient / 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
actual		Descriptive or actual
characteristic		Kind of characteristic
characteristic-value		A composite of both characteristic and value
code		The kind of resources contained
exclude		Group includes or excludes
managing-entity		Entity that is the custodian of the Group's definition
member		Reference to the group member
value		Value held by characteristic
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
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)
partof		A location of which this location is a part
active		Whether the patient record is active
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

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)