Practitioner_GET
GET {{baseUrl}}/Practitioner?_id=<string>&_lastUpdated=<date>&_profile=<string>&_security=<string>&_tag=<string>&address=<string>&address-city=<string>&address-country=<string>&address-postalcode=<string>&address-state=<string>&address-use=<string>&email=<string>&family=<string>&gender=<string>&given=<string>&phone=<string>&phonetic=<string>&telecom=<string>&active=<string>&communication=<string>&identifier=<string>&name=<string>&_format=<string>
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
_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 | |
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 | |
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 | |
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 | |
active
| string | | Whether the practitioner record is active | |communication
| string | | One of the languages that the practitioner can communicate with | |identifier
| string | | A practitioner's Identifier | |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 | |_format
| string | | |
RESPONSES
status: OK
[{"resourceType":"\u003cstring\u003e","id":"\u003cstring\u003e","text":{"status":"\u003cstring\u003e","div":"\u003cstring\u003e"},"identifier":[{"system":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"active":"\u003cboolean\u003e","name":[{"family":["\u003cobject\u003e","\u003cobject\u003e"],"given":["\u003cobject\u003e","\u003cobject\u003e"],"prefix":["\u003cobject\u003e","\u003cobject\u003e"]}],"practitionerRole":[{"organization":{"reference":"\u003cstring\u003e"},"role":{"fhir_comments":["\u003cobject\u003e","\u003cobject\u003e"],"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"}}]},"period":{"start":"\u003cstring\u003e","end":"\u003cstring\u003e"},"location":[{"reference":"\u003cstring\u003e","display":"\u003cstring\u003e"}],"healthcareService":[{"reference":"\u003cstring\u003e"}]}],"qualification":[{"identifier":[{"system":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"code":{"text":"\u003cstring\u003e"},"period":{"start":"\u003cstring\u003e"},"issuer":{"display":"\u003cstring\u003e"}}]},{"resourceType":"\u003cstring\u003e","id":"\u003cstring\u003e","text":{"status":"\u003cstring\u003e","div":"\u003cstring\u003e"},"identifier":[{"system":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"active":"\u003cboolean\u003e","name":[{"family":["\u003cobject\u003e","\u003cobject\u003e"],"given":["\u003cobject\u003e","\u003cobject\u003e"],"prefix":["\u003cobject\u003e","\u003cobject\u003e"]}],"practitionerRole":[{"organization":{"reference":"\u003cstring\u003e"},"role":{"fhir_comments":["\u003cobject\u003e","\u003cobject\u003e"],"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"}}]},"period":{"start":"\u003cstring\u003e","end":"\u003cstring\u003e"},"location":[{"reference":"\u003cstring\u003e","display":"\u003cstring\u003e"}],"healthcareService":[{"reference":"\u003cstring\u003e"}]}],"qualification":[{"identifier":[{"system":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"code":{"text":"\u003cstring\u003e"},"period":{"start":"\u003cstring\u003e"},"issuer":{"display":"\u003cstring\u003e"}}]}]