Patient_GET
GET {{baseUrl}}/Patient?general-practitioner=<string>&link=<string>&organization=<string>&_id=<string>&_lastUpdated=<date>&_profile=<string>&_security=<string>&_tag=<string>&active=<string>&address=<string>&address-city=<string>&address-country=<string>&address-postalcode=<string>&address-state=<string>&address-use=<string>&animal-breed=<string>&animal-species=<string>&birthdate=<date>&death-date=<date>&deceased=<string>&email=<string>&family=<string>&gender=<string>&given=<string>&identifier=<string>&language=<string>&name=<string>&phone=<string>&phonetic=<string>&telecom=<string>&_format=<string>
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
general-practitioner | string | Patient's nominated general practitioner, not the organization that manages the record | |
link | string | All patients linked to the given patient | |
organization | string | The organization at which this person is a patient | |
_id | string | Logical id of this artifact | |
_lastUpdated | string | When the resource version last changed | |
_profile | string | Profiles this resource claims to conform to | |
_security | string | Security Labels applied to this resource | |
_tag | string | Tags applied to this resource | |
active | string | Whether the patient record is active | |
address | string | Multiple Resources: |
-
RelatedPerson: A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text
-
Practitioner: A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text
-
Person: A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text
-
Patient: A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text | |
address-city| string | | Multiple Resources: -
RelatedPerson: A city specified in an address
-
Practitioner: A city specified in an address
-
Person: A city specified in an address
-
Patient: A city specified in an address | |
address-country| string | | Multiple Resources: -
RelatedPerson: A country specified in an address
-
Practitioner: A country specified in an address
-
Person: A country specified in an address
-
Patient: A country specified in an address | |
address-postalcode| string | | Multiple Resources: -
RelatedPerson: A postal code specified in an address
-
Practitioner: A postalCode specified in an address
-
Person: A postal code specified in an address
-
Patient: A postalCode specified in an address | |
address-state| string | | Multiple Resources: -
RelatedPerson: A state specified in an address
-
Practitioner: A state specified in an address
-
Person: A state specified in an address
-
Patient: A state specified in an address | |
address-use| string | | Multiple Resources: -
RelatedPerson: A use code specified in an address
-
Practitioner: A use code specified in an address
-
Person: A use code specified in an address
-
Patient: A use code specified in an address | |
animal-breed| string | | The breed for animal patients | |animal-species| string | | The species for animal patients | |birthdate| string | | Multiple Resources: -
RelatedPerson: The Related Person's date of birth
-
Person: The person's date of birth
-
Patient: The patient's date of birth | |
death-date| string | | The date of death has been provided and satisfies this search value | |deceased| string | | This patient has been marked as deceased, or as a death date entered | |email| string | | Multiple Resources: -
PractitionerRole: A value in an email contact
-
RelatedPerson: A value in an email contact
-
Practitioner: A value in an email contact
-
Person: A value in an email contact
-
Patient: A value in an email contact | |
family| string | | Multiple Resources: -
Practitioner: A portion of the family name
-
Patient: A portion of the family name of the patient | |
gender| string | | Multiple Resources: -
RelatedPerson: Gender of the related person
-
Practitioner: Gender of the practitioner
-
Person: The gender of the person
-
Patient: Gender of the patient | |
given| string | | Multiple Resources: -
Practitioner: A portion of the given name
-
Patient: A portion of the given name of the patient | |
identifier| string | | A patient identifier | |language| string | | Language code (irrespective of use value) | |name| string | | 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| string | | Multiple Resources: -
PractitionerRole: A value in a phone contact
-
RelatedPerson: A value in a phone contact
-
Practitioner: A value in a phone contact
-
Person: A value in a phone contact
-
Patient: A value in a phone contact | |
phonetic| string | | Multiple Resources: -
RelatedPerson: A portion of name using some kind of phonetic matching algorithm
-
Practitioner: A portion of either family or given name using some kind of phonetic matching algorithm
-
Person: A portion of name using some kind of phonetic matching algorithm
-
Patient: A portion of either family or given name using some kind of phonetic matching algorithm | |
telecom| string | | Multiple Resources: -
PractitionerRole: The value in any kind of contact
-
RelatedPerson: The value in any kind of contact
-
Practitioner: The value in any kind of contact
-
Person: The value in any kind of contact
-
Patient: The value in any kind of telecom details of the patient | |
_format| string | | |
RESPONSES
status: OK
[{"resourceType":"\u003cstring\u003e","id":"\u003cstring\u003e","text":{"status":"\u003cstring\u003e","div":"\u003cstring\u003e"},"identifier":[{"use":"\u003cstring\u003e","system":"\u003cstring\u003e","value":"\u003cstring\u003e","type":{"coding":[{"system":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"code":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]}}],"active":"\u003cboolean\u003e","name":[{"use":"\u003cstring\u003e","family":["\u003cobject\u003e","\u003cobject\u003e"],"given":["\u003cobject\u003e","\u003cobject\u003e"]}],"gender":"\u003cstring\u003e","photo":[{"contentType":"\u003cstring\u003e","data":"\u003cstring\u003e"}],"contact":[{"relationship":[{"coding":[{"system":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"code":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]}],"organization":{"reference":"\u003cstring\u003e","display":"\u003cstring\u003e"}}],"managingOrganization":{"reference":"\u003cstring\u003e","display":"\u003cstring\u003e"},"link":[{"type":"\u003cstring\u003e","other":{"reference":"\u003cstring\u003e"}}]},{"resourceType":"\u003cstring\u003e","id":"\u003cstring\u003e","text":{"status":"\u003cstring\u003e","div":"\u003cstring\u003e"},"identifier":[{"use":"\u003cstring\u003e","system":"\u003cstring\u003e","value":"\u003cstring\u003e","type":{"coding":[{"system":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"code":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]}}],"active":"\u003cboolean\u003e","name":[{"use":"\u003cstring\u003e","family":["\u003cobject\u003e","\u003cobject\u003e"],"given":["\u003cobject\u003e","\u003cobject\u003e"]}],"gender":"\u003cstring\u003e","photo":[{"contentType":"\u003cstring\u003e","data":"\u003cstring\u003e"}],"contact":[{"relationship":[{"coding":[{"system":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"code":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]}],"organization":{"reference":"\u003cstring\u003e","display":"\u003cstring\u003e"}}],"managingOrganization":{"reference":"\u003cstring\u003e","display":"\u003cstring\u003e"},"link":[{"type":"\u003cstring\u003e","other":{"reference":"\u003cstring\u003e"}}]}]