v1

latestOpenAPI 3.0.12026-07-261252271.9 KB
Patient

search-type: Search for Patient instances

This is a search type

get/fhir/v2/Patient

Query parameters

_countstring

Number of records to use as the page size for paginated search. The maximum page size for this Resource is 50

_lastUpdatedstring date

This is an Optional Date in the format _lastUpdated=gtDATE, _lastUpdated=eqDATE and _lastUpdated=leDATE in the format yyyy-mm-dd

address-postalcodestring

A postalCode specified in an address

activestring

Whether the patient record is active (true|false)

birthdatestring date

This is the patient's Date of birth - Valid format yyyy-MM-dd

emailstring

A value in an email contact

familystring

This is the patient's last name - Supports exact matches

genderstring

This is the patient's gender - male, female, or unknown

general-practitionerstring

Patient's nominated general practitioner, not the organization that manages the record

givenstring

A portion of the given name of the patient

identifierstring

This is a List of Identifiers for a Patient. Valid Identifier Systems are MRN with a system value of https://www.hl7.org/fhir/v2/0203/index.html#v2-0203-MR, SSN with a system value of http://hl7.org/fhir/sid/us-ssn, or PMS to be used for the PMS Id

languagestring

Language code (irrespective of use value)

pagestring

Page to be used for paginated search

phonestring

A value in a phone contact

us-core-ethnicitystring

Returns patients with an ethnicity extension matching the specified code. Detailed Extension specification can be found at: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity.

us-core-racestring

Returns patients with a race extension matching the specified code. Detailed Extension specification can be found at: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race.

referral-sourcestring

If the Patient has been assigned a Referral Source in MMPM, this will be a reference to that ID. Referral Sources can be found by querying the following Value Set: {base url}/{firm_url_prefix}/ema/fhir/v2/ValueSet/referral-source

Headers

Content-flag'Referral'

Optional header. Referral adds Referral Contact and Referral Source information to the Patient payload.

Response

Success